Insert a Host

Push Host

POST https://api.w3lcome.com/v1/hosts

This endpoint allows you to add a host

Headers

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

Request Body

Name	Type	Description
email	string	The email must be unique at each company
name	string
sendInvitationEmail	boolean	If true, W3lcome will send an email inviting the host to create an account at w3lcome.com. Default: false
role	string	One of employee, admin, frontDesk, manager, host
metadata	object	Optional object
isActive	boolean
additionalEmails	string	Emails separated by space
pictureUrl	string
position	string
sector	string
phone	string
countryCode	string
message	string

200 Success

{
    "id": "5d13bad4ae9c50948f6edd67a16d6936",
    "email": "[e-mail]",
    "name": "Alisson Enz Rossi",
    "isActive": true,
    "pictureUrl": "",
    "position": "CTO",
    "sector": "IT",
    "phone": "(43) 9 9982-0420",
    "countryCode": "+55",
    "isPhoneValid": true,
    "company": "W3lcome",
    "type": "host",
    "message": "",
    "role": "admin"
}

400 Error

{
    "type": "ALREADY_EXISTS"
}