Skip to main content
POST
Register via bot signup

Body

application/json
terms_of_service
enum<boolean>
required

Must be true to accept the terms of service.

Available options:
true
Example:

true

terms_and_conditions_url
string
required

Must exactly match the terms-and-conditions URL returned by the challenge endpoint.

Example:

"https://telnyx.com/terms-and-conditions-of-service"

privacy_policy_url
string
required

Must exactly match the privacy-policy URL returned by the challenge endpoint.

Example:

"https://telnyx.com/privacy-policy"

bot_challenge_nonce
string<uuid>
required

Nonce from a previously issued bot challenge.

Example:

"c6feda4e-6501-4db9-a21f-665e5b4ce2ba"

bot_challenge_answer
string
required

Answer to the issued bot challenge.

Example:

"35"

email
string<email>

Email address for the new account. The magic link is sent here. May only be omitted when placeholder-email registration is enabled server-side.

Example:

"agent-owner@example.com"

terms_of_service_eu
enum<boolean>

EU terms-of-service acceptance. Required when EU consent enforcement is enabled.

Available options:
true
Example:

true

terms_and_conditions_eu_url
string

EU terms-and-conditions URL. Required when EU consent enforcement is enabled.

Example:

"https://telnyx.com/terms-and-conditions-of-service-eu"

Response

Registration accepted and a magic link emailed.

Status envelope used by the signup and magic-link flows.

success
boolean
required

Whether the request was accepted.

Example:

true

message
string
required

Human-readable status message.

Example:

"A one-time sign-in link has been sent to your email address."