SIsinch
Services

Suspend a number on the service

Changed on

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

patch/v3/projects/{projectId}/services/{id}/numbers/{phoneNumber}/suspend

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services/{id}/numbers/{phoneNumber}/suspend
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

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 '+'.

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.

createdAtstring date-time

The timestamp on which the phone number was created.

updatedAtstring date-time

The timestamp on which the phone number was updated.

Example response

{
  "phoneNumber": "+15551235656",
  "country": "US",
  "suspended": true,
  "note": "Reason for suspending the number.",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
  "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J",
  "createdAt": "2025-10-24 18:56:42+00:00",
  "updatedAt": "2025-10-24 19:11:50+00:00"
}

Changes

  • d3054d7412d5Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 7f5e54fa9f05Revision changes
    • info

      endpoint added