Sign in
Services

Suspend a number on the service

Suspends a number assigned to the specified service. You can include a note as to the reason of the suspension.

patch/services/{id}/numbers/{phoneNumber}/suspend

Request body

suspendedboolean

Set to true to suspend a number.

notestring

An optional field to include a note providing context about the suspension.

Example request

{
  "suspended": true,
  "note": "Reason for suspending the number."
}

Response

Response detailing the suspended number.

phoneNumberstring phoneNumber

A phone number in E.164 format, including the leading '+'.

permissions'both' | 'send' | 'receive'

Allows you to set permissions for sending and receiving faxes to this email/phone number combination. Default value is both.

countrystring

The country code of the phone number in ISO 3166-1 alpha-2 format.

suspendedboolean

Specifies if a number is suspended or not.

notestring

An optional field providing context about the suspension.

projectIdstring

The Id of the project associated with the call.

serviceIdstring

ID of the fax service used.

Example response

{
  "phoneNumber": "+15551235656",
  "country": "US",
  "suspended": true,
  "note": "Reason for suspending the number.",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
  "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
}

Changes