numbers.release
Give a number back.
Reference
POST/api/v1/managed-numbers/{phone_number_id}/release
- Auth
- API key in
X-API-Key - Content
- application/json
- Returns
- 200 · Response Release Number Api V1 Managed Numbers Phone Number Id Release Post
Give a number back to the carrier. Irreversible.
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
phone_number_id | path | integer | required | |
reason | body | string | required | Why this number is being released. Required: release is irreversible and the number may be printed on the customer's signage. |
force | body | boolean | default false |
Example request
curl -X POST "https://api.decibyl.ai/api/v1/managed-numbers/<phone_number_id>/release" \
-H "X-API-Key: dcb_your_key" \
-H "Content-Type: application/json" \
-d '{"reason":"string","force":false}'Response
{}Errors
| Status | When |
|---|---|
404 | Not found |
422 | Validation Error |