> 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/insert-an-invitee.md).

# Insert an Invitee

## Push an Invitee

<mark style="color:green;">`POST`</mark> `https://api.w3lcome.com/v1/invitees`

This endpoint allows you to add an invitee

#### Headers

| Name           | Type   | Description      |
| -------------- | ------ | ---------------- |
| Content-Type   | string | application/JSON |
| Authentication | string | Basic `token`    |

#### Request Body

| Name                  | Type    | Description                                                                                                    |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| 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                                                                     |
| email                 | string  | If provided, it must be a valid email.                                                                         |
| address               | string  |                                                                                                                |
| company               | string  |                                                                                                                |
| position              | string  |                                                                                                                |
| sector                | string  |                                                                                                                |
| cardNumber            | number  |                                                                                                                |
| notes                 | string  |                                                                                                                |

{% tabs %}
{% tab title="200 Success" %}

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

{% endtab %}

{% tab title="400 Error" %}

```javascript
{
    "type": "INVALID_EMAIL"
}
```

{% endtab %}
{% endtabs %}