Skip to main content
PUT
/
v1
/
organization
/
phone-numbers
/
{phoneNumberId}
/
apps
cURL
curl --request PUT \
  --url https://api.buildwithchirp.com/v1/organization/phone-numbers/{phoneNumberId}/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appIds": [
    "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
  ]
}
'
{
  "phoneNumberId": "ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "number": "<string>",
  "location": "<string>",
  "features": [
    "<string>"
  ],
  "apps": [
    {
      "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "appName": "<string>",
      "appSlug": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
phoneNumberId
string
required

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

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

"ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
​
appIds
string[]
required

Array of app IDs to assign the phone number to

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

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

Response

Phone number app assignments updated 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"

​
number
string
required
​
numberType
enum<string>
required
Available options:
local,
tollfree,
mobile
​
location
string
required
​
features
string[]
required
​
apps
object[]
required
​
createdAt
string
required
​
updatedAt
string
required