ARartil
Addresses

Add an address

Leave out value to get a free address on the channel, or give an email address on the workspace's own domain. A phone number needs a plan that includes one. Give token to connect a Telegram bot, which then sends its messages to Artil.

post/agents/{id}/addresses

Request

  • Base URL
    https://app.artil.ai/api
  • URL
    https://app.artil.ai/api/agents/{id}/addresses
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://mcp.artil.ai/oauth/authorize
      Token URL: https://mcp.artil.ai/oauth/token scopes: agent

Path parameters

idstring uuid required

The agent's id

Request body

channel'email' | 'sms' | 'telegram' required
valuestring email
countrystring

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

tokenstring

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

Response

The new address

idstring uuid required
channel'email' | 'sms' | 'telegram' required
valuestring required

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

domainIdstring uuid nullable required

The workspace's own domain the address is on

primaryboolean required

Whether new messages on its channel go out from it

registeringboolean

Whether US carriers are still registering the phone number, which sends nothing until they have

createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.