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 '{}'{ "provider": "twilio", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "e164": "string", "country_code": "string", "number_type": "string", "capabilities": [ "string" ], "provisioning_state": "string", "is_dedicated": true, "messaging_service_sid": "string", "voice_agent_id": "2fc8d568-5ce2-4e51-baa8-38c877b5dd08", "sms_agent_id": "290deec0-b195-4d0c-9c32-ca9dce0ce328", "inbound_registered": false}Rotate Secret
Generate a new signing secret and immediately invalidate the old one. The response includes the new plaintext secret — this is the only time it is returned; update your verification code with it right away, since the old secret stops validating new deliveries immediately.
Unsubscribe
One-click email opt-out (RFC 8058), reached by clicking a link in a sent email. Public and unauthenticated — the signed token query param is the sole credential, proving the caller holds a link Hail sent to that address. On success, the address is added to the org's suppression list and all future outbound email to it is blocked. Returns an HTML page, not JSON.