Skip to content
Compliance Center/API reference/
/
Imports an existing Brand...

Imports an existing Brand in US.

Request

This endpoint allows you to import a brand that has already been registered through another reseller or directly by the end-customer, enabling you to manage it through your account. To initiate the transfer, you must specify one of the available import options (IMPORT_TCR_BRAND or IMPORT_GCH_BRAND) and provide the brand's unique ID from its original registry.

Upon receiving the request, the system will copy the brand's information from the source and create an import order that includes all existing third-party metadata from the original registration. Depending on the brand's original registry, an email will be sent to the brand's registered contact address to approve or deny the import request.

Please note that an imported brand cannot be directly modified or updated through our system. For example, a brand imported via IMPORT_GCH_BRAND cannot have its Short Code registration details changed, although it can be extended for other services like 10DLC if required. All maintenance and update operations for the brand remain the responsibility of the original register.

Security
OAuth2(Required scopes: write)
Path
projectIdstringrequired

Customer's project id

Bodyapplication/jsonrequired

Import Brand request body. It includes the import option to be used and the unique identifier of the brand in its original registry. Depending on the import option selected, the required identifier will differ, for IMPORT_TCR_BRAND, the required identifier is the 10DLC Brand ID; for IMPORT_GCH_BRAND, the required identifier is the US Short Code Registry Account ID.

displayNamestringrequired

The name of the brand. DisplayName must be unique per projectId and marketCode (US)

importTypestringrequired

Type of import, options are IMPORT_TCR_BRAND for 10DLC / RCS and IMPORT_GCH_BRAND for Short Code

Enum ValueDescription
IMPORT_TCR_BRAND

Import an existing brand in 10DLC. Imported brand will get same channels as in original request (10DLC, 10DLC+RCS). 10DLC brand Id must be included as external brand.

IMPORT_GCH_BRAND

Import an existing brand in the US Short Code Registry. Imported brand will get Short Code channel. The US Short Code Registry brand Id must be included as external brand.

externalBrandIdstringrequired

The external brand ID obtained in the original order. It can be the 10DLC brand Id or the US Short Code Registry brand Id.

callbackUrlstring, (uri)

The URL to receive the order status update callback. The URL must be a valid URL and must be reachable from Sinch.

curl -i -X POST \
  'https://compliance.api.sinch.com/v1/projects/{projectId}/us/brands/import' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "My End Customer Brand Name",
    "importType": "IMPORT_TCR_BRAND",
    "externalBrandId": "GW12345",
    "callbackUrl": "https://example.com/callback"
  }'

Responses

Brand import initiated successfully.

Bodyapplication/json
brandIdstringread-only

The unique identifier for the brand.

brandOrderIdstringread-only

The unique identifier for the brand order.

brandOwnerContactEmailstringread-only

The email of the brand owner contact provided in the original order, masked for privacy reasons. This field is included for informational purposes, but it is not intended for communication as the email is masked.

Response
{
  "brandId": "b1c7ccbf-919d-462f-8587-dec95a1b11ee",
  "brandOrderId": "212421442412",
  "brandOwnerContactEmail": "jo***@alphaadventures.com"
}
We'd love to hear from you!
Rate this content: