The Invitee Object

The Object

Attribute

Description

*id

stringrequired

It is a UUID v4 (36 characters long) automatically generated

*type

string required

This is an immutable field which indicates the type of the object. In this case 'invitee'

*expectedAt

stringrequired

Date and time of the invitee expected date, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)

*status

string required

Indicates the status of the invitee. It can be confirmed , arrived or canceled

event

string

Only used by Webhook Endpoint

lang

string

Invitee preferred language (E.g.: 'pt-BR')

name

string

Invitee name

host

object

The Host Object

phone

string

Invitee phone

cpf

string

Invitee CPF (Brazil only).

rg

string

Invitee RG (Brazil only).

document

string

Invitee document.

email

string

Invitee email.

address

string

Invitee address.

company

string

Invitee company.

position

string

Invitee position.

sector

string

Invitee sector.

customFields

array

Invitee extra fields following the Custom Field Object

cardNumber

int32

Random Int32 number. This is used to integrate with ticket gate.

notes

string

Private notes.

Short Sample

{
"type":"invitee",
"id":"01f9a209-644d-4c53-9207-26a304f51a1e",
"expectedAt":"2019-09-04T14:00:00-03:00",
"status":"arrived",
"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":"26"
}],
"cardNumber": 1234,
"notes":""
}

Available Methods

Table of Errors

Method

Type

GET /invitees

INVALID_LIMIT_VALUE

INVALID_OFFSET_VALUE

INVALID_QUERY_OPERATOR

INVALID_QUERY_KEY INTERNAL

PATCH

MISSING_NOT_FOUND

INVALID_CPF

INVALID_EMAIL

INVALID_STATUS

INVALID_CARD_NUMBER

GET PATCH DELETE

NOT_FOUND

GET PATCH DELETE

MISSING_ID

GET PATCH DELETE

UNAUTHORIZED