The Host Object

Host is the person inside the company who is going to receive visits and/or have access to the platform

The Object

Attribute	Description
*id stringrequired	It is a unique 32 characters string
*name stringrequired	The name of the host. It is required
*email stringrequired	Must be a valid email address, and it is unique in a company
*type stringimmutable	This is an immutable field that indicated the type of the object. In this case 'host'
event string	Only used by Webhook Endpoint
isActive bool	A boolean value indicating if the host is active on the iPad or not
pictureUrl string	The URL of an image. It can be a .png or .jpg
position string	The current position of the host
sector string	The current sector of the host
phone string	It can be only numbers, or formatted but must be a string
countryCode string	If the phone is provided the countryCode must be provided too. Here you can find a list of valid country codes. E.g.: +55
isPhoneValid bool	An automatic check that W3lcome's server do to verify if the phone is valid or not
company string	The current company of the host
message string	A custom message to display at the end of the check-in process
metadata object	A custom object used to add any type of information to the host
role string	The role of the host. It can be employee, admin, frontDesk, manager or host. Default employee

Short Sample

{
    "id": "5d13bad4ae9c50948f6edd67a16d6936",
    "email": "[e-mail]",
    "name": "Alisson Enz Rossi",
    "isActive": true,
    "position": "CTO",
    "sector": "IT",
    "company": "W3lcome"
    "metadata": {
        "myCustomId": "aabbcc",
        "cardNumber": 112233,
        ...
    },
    "role": "employee"
}

Available Methods

• GET /v1/host/:id

• GET /v1/hosts

• POST /v1/hosts

• PATCH /v1/host/:id

• DELETE /v1/host/:id

Table of Errors

Method	Type	Description
GET /hosts	INVALID_QUERY_OPERATOR INVALID_LIMIT_VALUE INVALID_OFFSET_VALUE
POST /hosts	MISSING_NAME
POST /hosts	MISSING_EMAIL
POST /hosts	INVALID_EMAIL
POST /hosts	ALREADY_EXISTS
PATCH /host/:id	CANNOT_CHANGE_HOST_EMAIL
POST PATCH	INVALID_ROLE
DELETE GET PATCH	NOT_FOUND
DELETE GET PATCH	MISSING_ID
GET POST PATCH DELETE	INTERNAL
GET POST PATCH DELETE	UNAUTHORIZED