Insert an Invitee

post
Push an Invitee

https://api.w3lcome.com/v1/invitees
This endpoint allows you to add an invitee
Request
Response
Request
Headers
Content-Type
required
string
application/JSON
Authentication
required
string
Basic token
Body Parameters
expectedAt
required
string
ISO 8601 format
name
required
string
The invitee name
host
required
object
The Host Object
pictureUrl
optional
string
The URL of the invitee picture or a base64 string
status
optional
string
The invitee status. Can be confirmed, arrived or canceled. If not provided it will be set to confirmed
phone
optional
string
Required if it's the company's primary key
cpf
optional
string
Brazil only. Must be a valid CPF
rg
optional
string
Brazil only.
document
optional
string
Required if it's the company's primary key
email
optional
string
If provided, it must be a valid email.
address
optional
string
company
optional
string
position
optional
string
sector
optional
string
cardNumber
optional
number
notes
optional
string
Response
200: OK
Success
{
"type":"invitee",
"id":"01f9a209-644d-4c53-9207-26a304f51a1e",
"expectedAt":"2019-09-04T14:00:00-03:00",
"status":"confirmed",
"lang":"pt-BR",
"name":"Mateus Schmidt",
"host": {
"type":"host",
"id":"142e81feb92c0a66ee70fd7f4e57a28d",
"email":"alisson@w3lcome.com",
"name":"Alisson Enz Rossi",
"position":"CTO",
"sector":"IT",
"phone":"(43) 99982-0420",
"countryCode":"+55"
},
"phone":"(43) 9 9999-9999",
"email":"mateus@w3lcome.com",
"company":"W3lcome",
"customFields":[{
"id":"IduZUQEh3",
"name":"Qual sua idade?",
"type":"Text",
"value":"27"
}],
"notes":""
}
400: Bad Request
Error
{
"type": "INVALID_EMAIL"
}