Update phone number

curl --request PATCH \
  --url https://api.topcalls.ai/v1/phone-numbers/{phone_number_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "inactive"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "+18005551234",
  "source": "topcalls",
  "status": "active",
  "phone_number_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voip_carrier_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier_name": "<string>",
  "label": "<string>",
  "error_message": "<string>",
  "inbound": {
    "enabled": true,
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Invalid API key"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

PATCH

phone-numbers

{phone_number_id}

curl --request PATCH \
  --url https://api.topcalls.ai/v1/phone-numbers/{phone_number_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "inactive"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "+18005551234",
  "source": "topcalls",
  "status": "active",
  "phone_number_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voip_carrier_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier_name": "<string>",
  "label": "<string>",
  "error_message": "<string>",
  "inbound": {
    "enabled": true,
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Invalid API key"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "code": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

phone_number_id

string<uuid>

required

Phone number UUID

Body

application/json

Send at least one field.

label

string

Your label

Required string length: 1 - 200

status

enum<string>

Can't be changed while the number is failed or pending (422).

Available options:

active,

inactive

inbound

object

Which campaign answers calls to this number. Greeting, hours, max duration and webhook are set on the campaign, not here.

Show child attributes

Response

Phone number updated

string<uuid>

Phone number UUID

account_id

string<uuid>

Account UUID

number

string

Phone number in E.164 format

Example:

"+18005551234"

source

enum<string>

topcalls is on the TopCalls carrier, byoc on one of your carriers.

Available options:

topcalls,

byoc,

manual,

import,

twilio

status

enum<string>

active: ready to use.
inactive: turned off by you, still provisioned.
pending: provisioning in progress.
failed: provisioning failed. See error_message.

Available options:

active,

inactive,

pending,

failed

phone_number_sid

string<uuid> | null

The number's ID in the phone system

voip_carrier_sid

string<uuid> | null

The carrier's voip_carrier_sid. null on the TopCalls carrier.

carrier_name

string | null

Carrier display name. TopCalls Managed on the TopCalls carrier.

label

string | null

Your label

error_message

string | null

Why provisioning failed, when status is failed

inbound

object

Current inbound routing, always present. After you disable routing, campaign_id still names the last campaign.

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

Overview

Calls

Phone Numbers

Lead lists

Leads

Campaigns

Knowledge Bases

Webhooks

Configuration

Account

Authorizations

Path Parameters

Body

Response