Add phone number to app

curl --request POST \ --url https://api.buildwithchirp.com/v1/organization/apps/{appId}/phone-numbers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "phoneNumberId": "ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI", "telnyxMessagingProfile": "1234567890abcdef" } '

{ "phoneNumberId": "ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI", "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI", "number": "<string>", "numberType": "local", "location": "San Francisco, CA", "features": [ "SMS", "MMS", "Voice" ], "createdAt": "<string>", "updatedAt": "<string>" }

Authorizations

Authorization

string

header

required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

appId

string

required

Unique identifier for a App. Format: app_[test_]{ksuid}

Pattern: ^app_(?:test_)?[a-zA-Z0-9]{27}$

Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json

phoneNumberId

string

required

ID of the phone number to add to the app

Pattern: ^ph_(?:test_)?[a-zA-Z0-9]{27}$

Example:

"ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

telnyxMessagingProfile

string

required

Telnyx messaging profile ID

Example:

"1234567890abcdef"

Response

Phone number added successfully

phoneNumberId

string

required

Unique identifier for a Phone Number. Format: ph_[test_]{ksuid}

Pattern: ^ph_(?:test_)?[a-zA-Z0-9]{27}$

Example:

"ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

appId

string

required

Unique identifier for a App. Format: app_[test_]{ksuid}

Pattern: ^app_(?:test_)?[a-zA-Z0-9]{27}$

Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

number

string

required

numberType

enum<string>

required

Type of phone number

Available options:

local,

tollfree,

mobile

Example:

"local"

location

string

required

Geographic location of the phone number

Example:

"San Francisco, CA"

features

string[]

required

Features supported by the phone number

Example:

["SMS", "MMS", "Voice"]

createdAt

string

required

updatedAt

string

required