---
title: "Text enable Toll Free qualified numbers"
method: POST
path: "/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers"
tags: ["Qualified Numbers"]
---

# Text enable Toll Free qualified numbers

`POST /v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers`

Text enable Toll Free qualified numbers of a specific project by creating a hosting order.

## Path parameters

- `projectId` string, required

## Request body

- union — Request for text enabling project Toll Free numbers.
  - object
    - `allOf` TextEnableTollFreeNumbersLoaInfoCommon
      - `projectId` string, required — The project id we want the numbers to be enabled for.
      - `displayName` string — The display name of the numbers.
      - `regionCode` string, required — ISO 3166-1 alpha-2 country code of the phone number. Example: US, CA
      - `numbers` string[], required
      - `scheduledZipwhipProvisioningTime` string — Optional field which allow to determine when Zipwhip provisioning will be done. Timestamp needs to be from UTC zone. Important! If LOA is signed after `scheduledZipwhipProvisioningTime`, date will be rescheduled to the next day at the same time.
      - `servicePlanId` string, required — The SMS service that the number will be linked to. The `servicePlanId` can be found in the [Sinch Customer Dashboard](https://dashboard.sinch.com/sms/api/rest).
      - `callbackUrl` string — The callback URL to be called for text enablement updates
    - `directLoaInfo` DirectLoaInfo, required — Letter of Authorization for direct Sinch customers.
      - `authorisedPerson` AuthorizedPerson, required — The person authorized and responsible for the hosting order.
        - `firstName` string, required — The first name of the authorized person.
        - `lastName` string, required — The last name of the authorized person.
        - `email` string, required — The email address of the authorized person.
      - `address` Address, required — The address of the business.
        - `buildingNumber` string, required — The building number of the address.
        - `street` string, required — The street name of the address.
        - `city` string, required — The city name of the address.
        - `state` string, required — The state name of the address.
        - `postalCode` string, required — The postal code of the address.
        - `country` string, required — The country of the address.
      - `currentVoiceCarrier` string, required — The current carrier you are using for voice services for the number you want to host on Sinch.
  - object
    - `allOf` TextEnableTollFreeNumbersLoaInfoCommon
      - `projectId` string, required — The project id we want the numbers to be enabled for.
      - `displayName` string — The display name of the numbers.
      - `regionCode` string, required — ISO 3166-1 alpha-2 country code of the phone number. Example: US, CA
      - `numbers` string[], required
      - `scheduledZipwhipProvisioningTime` string — Optional field which allow to determine when Zipwhip provisioning will be done. Timestamp needs to be from UTC zone. Important! If LOA is signed after `scheduledZipwhipProvisioningTime`, date will be rescheduled to the next day at the same time.
      - `servicePlanId` string, required — The SMS service that the number will be linked to. The `servicePlanId` can be found in the [Sinch Customer Dashboard](https://dashboard.sinch.com/sms/api/rest).
      - `callbackUrl` string — The callback URL to be called for text enablement updates
    - `resellerLoaInfo` ResellerLoaInfo, required — Letter of Authorization for resellers.
      - `businessName` string, required — The name of the business.
      - `authorisedPerson` AuthorizedPerson, required — The person authorized and responsible for the hosting order.
        - `firstName` string, required — The first name of the authorized person.
        - `lastName` string, required — The last name of the authorized person.
        - `email` string, required — The email address of the authorized person.
      - `address` Address, required — The address of the business.
        - `buildingNumber` string, required — The building number of the address.
        - `street` string, required — The street name of the address.
        - `city` string, required — The city name of the address.
        - `state` string, required — The state name of the address.
        - `postalCode` string, required — The postal code of the address.
        - `country` string, required — The country of the address.
      - `currentVoiceCarrier` string, required — The current carrier you are using for voice services for the number you want to host on Sinch.

## Response `200`

A successful response with a hosting order, or an error

- HostingOrder
  - `projectId` string — The project ID to which the hosting order is associated.
  - `hostingOrderId` string — The unique ID of the hosting order.
  - `displayName` string — The friendly name of the hosting order.
  - `regionCode` string — The region code of the hosting order. Number hosting is only available for the US and Canada, so you must enter either "US" or "CA".
  - `state` 'HOSTING_ORDER_STATE_UNSPECIFIED' | 'DRAFT' | 'SUBMITTED' | 'WAITING_FOR_LOA_SIGNATURE' | 'IN_PROGRESS' | 'COMPLETED' | 'REJECTED' — The state of the hosting order.
  - `type` 'HOSTING_ORDER_TYPE_UNSPECIFIED' | 'IMPORT' | 'TYPE_TEXT_ENABLE' — The hosting order type.
  - `createdTime` string, date-time — Timestamp when the hosting order was created
  - `updatedTime` string, date-time — Timestamp when the hosting order was last updated
  - `scheduledOsrUpdateTime` string, date-time — Timestamp when the OSR update will be done
  - `servicePlanId` string — The service plan to which the hosting order is associated.
  - `campaignId` string — The campaign to which the hosting order is associated.
  - `migrateToSinchTmo` boolean — Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch.
  - `textEnableInfo` TextEnableInfo
    - `businessName` string — The name of the business.
    - `authorisedPerson` AuthorizedPerson — The person authorized and responsible for the hosting order.
      - `firstName` string, required — The first name of the authorized person.
      - `lastName` string, required — The last name of the authorized person.
      - `email` string, required — The email address of the authorized person.
    - `address` Address — The address of the business.
      - `buildingNumber` string, required — The building number of the address.
      - `street` string, required — The street name of the address.
      - `city` string, required — The city name of the address.
      - `state` string, required — The state name of the address.
      - `postalCode` string, required — The postal code of the address.
      - `country` string, required — The country of the address.
    - `serviceProvider` string
    - `currentVoiceCarrier` string — The current carrier you are using for voice services for the number you want to host on Sinch.
    - `nnid` string — The Net Number ID for the number you want to host on Sinch.
    - `loaType` 'Direct' | 'Reseller', enum — The type of the letter of authorization.
  - `callbackUrl` string — The client's callback URL to be called upon finishing the number import.

## Other responses

- `400` — Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid
- `404` — The imported number, project, hosting order, qualified number or phone number could not be found
- `409` — The imported number already exists and cannot be created
- `500` — 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)