---
title: "Update imported number"
method: PATCH
path: "/v1/projects/{projectId}/importedNumbers/{phoneNumber}"
tags: ["Imported Numbers"]
---

# Update imported number

`PATCH /v1/projects/{projectId}/importedNumbers/{phoneNumber}`

Update an imported phone number. You can perform the following updates:

* Update the name that displays for a customer by modifying the `displayName` parameter.
* Unlink the number from an SMS service or campaign by updating the `smsConfiguration` configuration object. To unlink a number, submit the request with an empty string (`””`) in the service plan ID or campaign ID fields.
* Before linking a number to a new service or campaign, it must be unlinked from any existing service or campaign. Then, link the number to a new SMS service or campaign by updating the service plan ID or campaign ID with the new desired value.

## Path parameters

- `projectId` string, required
- `phoneNumber` string, required

## Request body

- ImportedNumber
  - `phoneNumber` string — The phone number in e.164 format with leading +.
  - `projectId` string — The ID of the project resource. You can find your project ID on dashboard.sinch.com.
  - `regionCode` string — ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.
  - `displayName` string — User supplied name for the phone number.
  - `smsConfiguration` SmsConfiguration — Configuration for SMS
    - `servicePlanId` string — The current SMS configuration for this number. The `servicePlanId`` can be found when logging into dashboard.sinch.com in the SMS>APIs section.
    - `scheduledProvisioning` ScheduledProvisioning — Ongoing Provisioning for SMS service
      - `servicePlanId` string — Service plan of the scheduled provisioning task.
      - `status` integer — Status of the pending change.
      - `lastUpdatedTime` string, date-time — Timestamp when the status was last updated.
      - `campaignId` string — The campaign of the scheduled provisioning task.
      - `errorCodes` integer[] — A list of error codes, if applicable, for the scheduled provisioning task.
    - `campaignId` string — The current campaign ID assigned to this number.
    - `migrateToSinchTmo` boolean — Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.
  - `callbackUrl` string — The client's callback URL to be called upon finishing the number import.

## Response `200`

OK

- ImportedNumber
  - `phoneNumber` string — The phone number in e.164 format with leading +.
  - `projectId` string — The ID of the project resource. You can find your project ID on dashboard.sinch.com.
  - `regionCode` string — ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.
  - `displayName` string — User supplied name for the phone number.
  - `smsConfiguration` SmsConfiguration — Configuration for SMS
    - `servicePlanId` string — The current SMS configuration for this number. The `servicePlanId`` can be found when logging into dashboard.sinch.com in the SMS>APIs section.
    - `scheduledProvisioning` ScheduledProvisioning — Ongoing Provisioning for SMS service
      - `servicePlanId` string — Service plan of the scheduled provisioning task.
      - `status` integer — Status of the pending change.
      - `lastUpdatedTime` string, date-time — Timestamp when the status was last updated.
      - `campaignId` string — The campaign of the scheduled provisioning task.
      - `errorCodes` integer[] — A list of error codes, if applicable, for the scheduled provisioning task.
    - `campaignId` string — The current campaign ID assigned to this number.
    - `migrateToSinchTmo` boolean — Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.
  - `callbackUrl` string — The client's callback URL to be called upon finishing the number import.

## Other responses

- `400` — INVALID_ARGUMENT: If the fieldMask is not provided or importedNumber.smsConfiguration.servicePlanId is not valid.
- `404` — The imported number could not be found.
- `500` — INTERNAL: Internal server error. Typically, a server bug.

---

[API](https://skmtc.net/sinch/apis/imported-numbers-and-hosting-orders.md) · [All operations](https://skmtc.net/sinch/apis/imported-numbers-and-hosting-orders/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/imported-numbers-and-hosting-orders/revisions/c3d50cf4681d/schema)