Insert an Invitee
Push an Invitee
POST https://api.w3lcome.com/v1/invitees
This endpoint allows you to add an invitee
Headers
Content-Type
string
application/JSON
Authentication
string
Basic token
Request Body
expectedAt
string
ISO 8601 format
name
string
The invitee name
host
object
The Host Object
requiresAuthorization
boolean
Default: false
pictureUrl
string
The URL of the invitee picture or a base64 string
status
string
The invitee status. Can be confirmed, arrived or canceled. If not provided it will be set to confirmed
phone
string
Required if it's the company's primary key
cpf
string
Brazil only. Must be a valid CPF
rg
string
Brazil only.
document
string
Required if it's the company's primary key
string
If provided, it must be a valid email.
address
string
company
string
position
string
sector
string
cardNumber
number
notes
string
{
    "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":"[email protected]",
        "name":"Alisson Enz Rossi",
        "position":"CTO",
        "sector":"IT",
        "phone":"(43) 99982-0420",
        "countryCode":"+55"
    },
    "phone":"(43) 9 9999-9999",
    "email":"[email protected]",
    "company":"W3lcome",
    "customFields":[{
        "id":"IduZUQEh3",
        "name":"Qual sua idade?",
        "type":"Text",
        "value":"27"
    }],
    "notes":""
}{
    "type": "INVALID_EMAIL"
}Last updated
Was this helpful?