Route Number
Path Parameters
uuidHeader Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PATCH /numbers/{id}: which agent answers. A field left out keeps its
value; null detaches.
Response Body
application/json
curl -X PATCH "https://example.com/v1/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "e164": "string", "country_code": "string", "number_type": "string", "capabilities": [ "string" ], "provisioning_state": "string", "is_dedicated": true, "voice_agent_id": "2fc8d568-5ce2-4e51-baa8-38c877b5dd08", "sms_agent_id": "290deec0-b195-4d0c-9c32-ca9dce0ce328", "inbound_registered": false, "subject_type": "person", "verification_id": "5bcbf7ac-c998-46ce-aa6e-a0c1a3f1f5bd", "subject_name": "string"}Rotate Tool Secret
Make a new secret for this agent's HTTP tool requests. The response's ``http_tool_secret`` is the only time it is shown. The old secret stops signing at once; live calls keep the one they started with.
Start Sms Trial Phone
Text a 6-digit code to the workspace's own US mobile. The code expires in 10 minutes. A new code replaces the old one. A verified phone keeps getting trial texts until the new phone is confirmed; until then the new phone shows as pending_phone. Asking again for the verified phone drops the waiting new phone. A workspace or a phone gets at most 5 codes in 24 hours. Code texts are free and do not count toward the 25 trial texts. Console sessions only.