Unassign Number

Removes the current assistant assignment for an owned phone number.

Request

Endpoint

DELETE/api/v1/numbers/assignment

Authentication

x-api-keyorAuthorization: Bearer

Body Parameters

Name	Type	Description
`phone_number`required	string	Owned phone number to unassign.

Request Body Example

body.json

{
  "phone_number": "+919876543210"
}

Notes

Returns 400 when the number is already unassigned.

Response Example

response.json

{
  "success": true,
  "data": {
    "phone_number": "+919876543210",
    "message": "+919876543210 unassigned from its assistant"
  }
}

Status Codes

HTTP	Meaning	Description
200	OK	Request succeeded.
400	Bad request	Malformed input, invalid ObjectId, or no updatable fields.
401	Unauthorized	Missing, invalid, inactive, or origin-restricted API key.
404	Not found	Resource was not found inside the authenticated user's scope.
415	Unsupported media type	Content-Type header is missing or is not application/json.
422	Validation error	JSON body failed schema or business validation.
429	Rate limited	Per-IP or per-key request budget was exceeded.

Security Model

User-scoped by default

This endpoint only sees resources owned by the user attached to the API key. If another user's id is supplied, the API responds as if the resource does not exist.

DELETE/api/v1/numbers/assignment

Phone Numbers

Unassign Number

Removes the current assistant assignment for an owned phone number.

Request

Endpoint

DELETE/api/v1/numbers/assignment

Authentication

x-api-keyorAuthorization: Bearer

Body Parameters

Name	Type	Description
`phone_number`required	string	Owned phone number to unassign.

Request Body Example

body.json

{
  "phone_number": "+919876543210"
}

Notes

Returns 400 when the number is already unassigned.

Response Example

response.json

{
  "success": true,
  "data": {
    "phone_number": "+919876543210",
    "message": "+919876543210 unassigned from its assistant"
  }
}

Status Codes

HTTP	Meaning	Description
200	OK	Request succeeded.
400	Bad request	Malformed input, invalid ObjectId, or no updatable fields.
401	Unauthorized	Missing, invalid, inactive, or origin-restricted API key.
404	Not found	Resource was not found inside the authenticated user's scope.
415	Unsupported media type	Content-Type header is missing or is not application/json.
422	Validation error	JSON body failed schema or business validation.
429	Rate limited	Per-IP or per-key request budget was exceeded.

Security Model

User-scoped by default

This endpoint only sees resources owned by the user attached to the API key. If another user's id is supplied, the API responds as if the resource does not exist.