Skip to main content
POST
Add an address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The agent's id

Body

application/json
channel
enum<string>
required
Available options:
email,
sms,
telegram
value
string<email>
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
country
string

The ISO country of the phone number; the first one the server sells by default

Pattern: ^[A-Z]{2}$
token
string

The token @BotFather gave a Telegram bot the workspace already has

Minimum string length: 1

Response

The new address

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
channel
enum<string>
required
Available options:
email,
sms,
telegram
value
string
required

The email address, phone number or Telegram bot's @username

domainId
string<uuid> | null
required

The workspace's own domain the address is on

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
primary
boolean
required

Whether new messages on its channel go out from it

createdAt
string<date-time>
required