Update imported number

Numbers/

Request

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.

Security

Basic or OAuth2.0

Path

projectIdstringrequired

Found on your Sinch Customer Dashboard. Settings > Projects.

Example:d1923022-5199-4bb3-a513-c47b3a656bc5

phoneNumberstringrequired

The phone number in E.164 format with leading +.

Example:+12025550134

Bodyapplication/jsonrequired

phoneNumberstring

The phone number in e.164 format with leading +.

Example:"+12025550134"

projectIdstring

The ID of the project resource. You can find your project ID on dashboard.sinch.com.

Example:"YOUR_project_id"

regionCodestring

ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.

Example:"US"

displayNamestring

User supplied name for the phone number.

Example:"MyPhoneNumber"

smsConfigurationobject(SmsConfiguration)

Configuration for SMS

callbackUrlstring

The client's callback URL to be called upon finishing the number import.

Example:"https://www.your-callback-server.com/callback"

curl -i -X PATCH \
  -u '<username>:<password>' \
  'https://imported.numbers.api.sinch.com/v1/projects/d1923022-5199-4bb3-a513-c47b3a656bc5/importedNumbers/+12025550134' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "My Display Name",
    "smsConfiguration": {
      "servicePlanId": "",
      "campaignId": ""
    },
    "callbackUrl": "https://www.your-callback-server.com/callback"
  }'

Responses

Bodyapplication/json