Skip to main content
POST
Assign a BYO phone number

Authorizations

token
string
query
required

Vida API Token

Body

application/json
number
string
required

Phone Number to assign to your account

Example:

"+12145551234"

providerId
string

Numbering provider to assign the number through (e.g. Bird). Defaults to the account's configured provider.

Example:

"Bird"

channelId
string

For Bird BYO: the id of the existing SMS channel for this number.

Example:

"614208aa-1234"

Response

Successfully assigned phone number to account

success
boolean
Example:

true

message
string
Example:

"Success"