Sign in
latestOpenAPI 3.1.0MIT2026-08-102135157.7 KB

fcc788f31a0a

brands

Imports an existing Brand in US.

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.

post/v1/projects/{projectId}/us/brands/import

Path parameters

projectIdstring required

Customer's project id

Request body

displayNamestring required

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

importType'IMPORT_TCR_BRAND' | 'IMPORT_GCH_BRAND' required

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

externalBrandIdstring required

The external brand ID obtained in the original order. It can be the TCR brand Id or the GCH 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.

Example request

{
  "displayName": "My End Customer Brand Name",
  "importType": "IMPORT_TCR_BRAND",
  "externalBrandId": "GW12345",
  "callbackUrl": "https://example.com/callback"
}

Response

Brand import initiated successfully.

brandIdstring

The unique identifier for the brand.

brandOrderIdstring

The unique identifier for the brand order.

brandOwnerContactEmailstring

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.

Example response

{
  "brandId": "1234567890",
  "brandOrderId": "212421442412",
  "brandOwnerContactEmail": "bo***********@sinch.com"
}