Sign in
latestOpenAPI 3.0.3MIT2026-08-102357127.0 KB

c3d50cf4681d

Qualified Numbers

Text enable numbers

Enables text capability for the specified qualified numbers. You can enable up to 500 numbers at once. To enable a number for SMS, you must include a Campaign ID and billing information for a Letter of Authorization to be generated. The information required can differ depending on if you are a direct customer of Sinch or a reseller. The Letter of Authorization will be sent to the email you provide in the request to be e-signed.

post/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers

Path parameters

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

Found on your Sinch Customer Dashboard. Settings > Projects.

Request body

projectIdstring

The ID of the project to which the hosting order is associated.

displayNamestring

The optional display name of the hosting order.

regionCodestring required

The region code for the hosting order.

numbersstring[] required

An array of all the phone numbers associated with the hosting order.

nnidstring

Defaults to either Sinch NNID or what was originally configured on the customer account. Sinch encourages customers to use the Sinch NNID, but if you want to use another NNID, please contact your account manager.

servicePlanIdstring required

The ID of the service plan to which the hosting order is associated.

campaignIdstring

The ID of the campaign to which the hosting order is associated.

blanketLoaInfoBlanketLoaInfo

You can set up a blanket Letter of Authorization (LoA) that will allow you to import numbers to your account without having to sign an LoA each time you submit a request. To set up a blanket LoA, email your account manager. Once the LoA has been approved, you can use this blanketLoaInfo object in your requests. The blanketLoaInfo object should be sent as an empty object.

scheduledOsrUpdateTimestring date-time

The scheduled time for OSR to be updated.

migrateToSinchTmoboolean

Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.

callbackUrlstring

The client's callback URL to be called for text enablement updates.

Example request

{
  "projectId": "YOUR_project_id",
  "displayName": "MyHostingOrder",
  "regionCode": "US",
  "numbers": [
    "+12025550134"
  ],
  "servicePlanId": "YOUR_service_plan_id",
  "campaignId": "YOUR_campaign_id",
  "directLoaInfo": {
    "authorisedPerson": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@company.com"
    },
    "address": {
      "buildingNumber": "123",
      "street": "1st",
      "city": "New York",
      "state": "NY",
      "postalCode": "00001",
      "country": "USA"
    },
    "currentVoiceCarrier": "TMO"
  },
  "resellerLoaInfo": {
    "businessName": "Acme, Inc.",
    "authorisedPerson": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@company.com"
    },
    "address": {
      "buildingNumber": "123",
      "street": "1st",
      "city": "New York",
      "state": "NY",
      "postalCode": "00001",
      "country": "USA"
    },
    "currentVoiceCarrier": "TMO"
  },
  "callbackUrl": "https://www.your-callback-server.com/callback"
}

Response

OK

hostingOrderIdstring

The ID of the hosting order.