PATCH
/
numbers
/
{id}
/
use-case
curl --request PATCH \
  --url https://app.happyrobot.ai/api/v1/numbers/{id}/use-case \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "id": "<string>",
  "prompt_routes": [
    {
      "probability": 50,
      "prompt_id": "<string>",
      "model_id": "<string>"
    }
  ],
  "agent_routes": [
    {
      "probability": 50,
      "id": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "number": "+14155552671",
  "sid": "<string>",
  "locality": "San Francisco",
  "mode": "direct_transfer",
  "use_case_config": {
    "id": "<string>",
    "prompt_routes": [
      {
        "probability": 50,
        "prompt_id": "<string>",
        "model_id": "<string>"
      }
    ],
    "agent_routes": [
      {
        "probability": 50,
        "id": "<string>"
      }
    ]
  },
  "title": "<string>"
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Path Parameters

​
id
string
required

ID of the number.

Required string length: 24

Body

application/json
Body
​
id
string

ID of the use case that should handle inbound on this number.

​
prompt_routes
object[]

Prompt and model routes of the phone number.

​
agent_routes
object[]

Agent routes of the phone number.

Response

200
application/json
200
​
id
string
required

ID of the phone number.

​
organization_id
string
required

Organization ID.

​
number
string
required

Phone number.

Example:

"+14155552671"

​
sid
string
required

Twilio SID.

​
mode
enum<string>
required

Phone number mode.

Available options:
direct_transfer,
use_case,
previous_call
​
locality
string

Locality.

Example:

"San Francisco"

​
use_case_config
object

Use case configuration if in use case mode.

​
title
string

Title of the phone number.

Was this page helpful?

Update a phone number's modeUpdate a phone number's title