Insert a Host

post
Push Host

https://api.w3lcome.com/v1/hosts
This endpoint allows you to add a host
Request
Response
Request
Headers
Content-Type
required
string
application/JSON
Authentication
required
string
Basic token
Body Parameters
email
required
string
The email must be unique at each company
name
required
string
sendInvitationEmail
optional
boolean
If true, W3lcome will send an email inviting the host to create an account at w3lcome.com. Default: false
role
optional
string
One of employee, admin, frontDesk, manager, host
metadata
optional
object
Optional object
isActive
optional
boolean
additionalEmails
optional
string
Emails separated by space
pictureUrl
optional
string
position
optional
string
sector
optional
string
phone
optional
string
countryCode
optional
string
message
optional
string
Response
200: OK
Success
{
"id": "5d13bad4ae9c50948f6edd67a16d6936",
"email": "alisson@w3lcome.com",
"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: Bad Request
Error
{
"type": "ALREADY_EXISTS"
}