---
title: "Suspend a number on the service"
method: PATCH
path: "/v3/projects/{projectId}/services/{id}/numbers/{phoneNumber}/suspend"
tags: ["Services"]
---

# Suspend a number on the service

`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: one of:
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.sinch.com/oauth2/token`

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

## Request body

- SuspendRequest: The request body for suspending a number.
  - `suspended` boolean: Set to `true` to suspend a number.
  - `note` string: An optional field to include a note providing context about the suspension.

## Response `200`

Response detailing the suspended number.

- SuspendPhoneNumberResponse
  - `phoneNumber` string, phoneNumber: A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading '+'.
  - `country` string: The country code of the phone number in ISO 3166-1 alpha-2 format.
  - `suspended` boolean: Specifies if a number is suspended or not.
  - `note` string: An optional field providing context about the suspension.
  - `projectId` string: The `Id` of the project associated with the call.
  - `serviceId` string: ID of the fax service used.
  - `createdAt` string, date-time: The timestamp on which the phone number was created.
  - `updatedAt` string, date-time: The timestamp on which the phone number was updated.

## Changes

- **2026-10-21** `d3054d7412d5`: 1 warning, 2 info
  - removed the optional property `permissions` from the response with the `200` status
  - added the optional property `createdAt` to the response with the `200` status
  - added the optional property `updatedAt` to the response with the `200` status
- **2026-10-01** `7f5e54fa9f05`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sinch/apis/fax-api/changes/v3/projects/:projectId/services/:id/numbers/:phoneNumber/suspend/patch.md)

---

[API](https://skmtc.dev/sinch/apis/fax-api.md) - [All operations](https://skmtc.dev/sinch/apis/fax-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sinch/apis/fax-api/revisions/d3054d7412d5?raw)