> For the complete documentation index, see [llms.txt](https://docs.w3lcome.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.w3lcome.com/invitee/coming-soon.md).

# The Invitee Object

## The Object

| Attribute                                                                       | Description                                                                                                     |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| <p><strong>\*id</strong></p><p><em><code>string</code>required</em></p>         | It is a UUID v4 (36 characters long) automatically generated                                                    |
| <p><strong>\*type</strong></p><p><em><code>string</code> required</em></p>      | This is an immutable field which indicates the type of the object. In this case 'invitee'                       |
| <p><strong>\*expectedAt</strong></p><p><em><code>string</code>required</em></p> | Date and time of the invitee expected date, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds) |
| <p><strong>\*status</strong></p><p><em><code>string</code> required</em></p>    | Indicates the status of the invitee. It can be `confirmed` , `arrived` or `canceled`                            |
| <p><strong>event</strong></p><p><em><code>string</code></em></p>                | Only used by [Webhook Endpoint](/webhook/coming-soon.md)                                                        |
| <p><strong>lang</strong></p><p><em><code>string</code></em></p>                 | Invitee preferred language (E.g.: 'pt-BR')                                                                      |
| <p><strong>name</strong></p><p><em><code>string</code></em></p>                 | Invitee name                                                                                                    |
| <p><strong>host</strong></p><p><em><code>object</code></em></p>                 | [The Host Object](/host/the-host-object.md)                                                                     |
| **meeting** *`object`*                                                          | [The Meeting Object](/meeting/coming-soon.md) (The host is NOT included inside the meeting)                     |
| <p><strong>phone</strong></p><p><em><code>string</code></em></p>                | Invitee phone                                                                                                   |
| <p><strong>cpf</strong></p><p><em><code>string</code></em></p>                  | Invitee CPF (Brazil only).                                                                                      |
| <p><strong>rg</strong></p><p><em><code>string</code></em></p>                   | Invitee RG (Brazil only).                                                                                       |
| <p><strong>document</strong></p><p><em><code>string</code></em></p>             | Invitee document.                                                                                               |
| <p><strong>email</strong></p><p><em><code>string</code></em></p>                | Invitee email.                                                                                                  |
| <p><strong>address</strong></p><p><em><code>string</code></em></p>              | Invitee address.                                                                                                |
| <p><strong>company</strong></p><p><em><code>string</code></em></p>              | Invitee company.                                                                                                |
| <p><strong>position</strong></p><p><em><code>string</code></em></p>             | Invitee position.                                                                                               |
| <p><strong>sector</strong></p><p><em><code>string</code></em></p>               | Invitee sector.                                                                                                 |
| <p><strong>pictureUrl</strong><br><em><code>string</code></em></p>              | Invitee picture URL (It can be a base64 on the insert/update request)                                           |
| <p><strong>customFields</strong></p><p><em><code>array</code></em></p>          | Invitee extra fields following the [Custom Field Object](/visit/the-visit-object.md#custom-field-object)        |
| <p><strong>cardNumber</strong></p><p><em><code>int32</code></em></p>            | Random Int32 number. This is used to integrate with the ticket gate.                                            |
| <p><strong>notes</strong></p><p><em><code>string</code></em></p>                | Private notes.                                                                                                  |
| **requiresAuthorization** *`bool`*                                              | If `true` the visit will not be allowed by default. Default value is `false`                                    |

## Short Sample

```javascript
{
    "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":"",
    "requiresAuthorization": false
}
```

## Available Methods

* **`GET`** [/v1/invitee/:id](/invitee/retrieve-an-invitee.md)
* **`GET`** [/v1/invitees](/invitee/retrieve-a-list-of-invitees.md)
* **`PATCH`** [/v1/invitee/:id](/invitee/update-an-invitee.md)
* **`DELETE`** [/v1/invitee/:id](/invitee/delete-an-invitee.md)

## Table of Errors

| Method                 | Type                                                                                                                        |   |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | - |
| `GET` /invitees        | <p>INVALID\_LIMIT\_VALUE</p><p>INVALID\_OFFSET\_VALUE</p><p>INVALID\_QUERY\_OPERATOR</p><p>INVALID\_QUERY\_KEY INTERNAL</p> |   |
| `PATCH`                | <p>MISSING\_NOT\_FOUND</p><p>INVALID\_CPF</p><p>INVALID\_EMAIL</p><p>INVALID\_STATUS</p><p>INVALID\_CARD\_NUMBER</p>        |   |
| `GET` `PATCH` `DELETE` | NOT\_FOUND                                                                                                                  |   |
| `GET` `PATCH` `DELETE` | MISSING\_ID                                                                                                                 |   |
| `GET` `PATCH` `DELETE` | UNAUTHORIZED                                                                                                                |   |