10DLC Campaign Registration

10DLC is a system in the United States that allows businesses to send Application-to-Person (A2P) messaging via 10-digit-long-codes (10DLC). It uses a dedicated 10-digit telephone number allocated within the North American Numbering Plan (NANP).

In order to register for a 10DLC campaign, you need to have a 10DLC enabled brand. Create a 10DLC enabled brand before you start, see Brand Registrations for more info.

Before you launch your 10DLC message program, Sinch must review your campaign. We make sure your message program aligns with carrier and industry requirements. Principally we look for alignment with the CTIA 2023 Messaging Principals & Best Practices. If your campaign does not meet these requirements, we will reject it. If we do reject it, you will need to make changes to the campaign and resubmit it for Sinch to review again.

It's important to understand 10DLC compliance requirements as well as other best practices. You should also know the most common reasons why Sinch may reject your campaign . We want to help you get your campaigns approved the first time. Then you can get your message program up and running right away!

Create new Campaign in TCR

Create a 10DLC campaign at TCR (The Campaign Registry).

Campaign fees and carrier requirements are determined by the brand and use-case being used. To check the campaign requirements, use the campaign:qualify API.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.

Request Body schema: application/json
required
brandId
required
string <= 8 characters

The brand is the company or entity represented in the campaign. The brand ID is an alphanumeric identifier that always begins with a "B". When registering a brand in The Campaign Registry (TCR), TCR returns a brand ID value, example: BESINCH. For more info, see Brand Registrations.

useCase
required
string (Campaign Usecase Type)

Select a use case that is the primary use case that is most applicable to the service that messages are providing to subscribers. Standard use cases are immediately available for all qualified registered brands, whereas special use cases require vetting or pre/post approval by mobile network operators (MNOs).

Special use cases are sensitive or critical in nature and may require vetting or pre/post registration approval by mobile network operators (MNOs). Requirements may vary according to each MNO.

For more information on standard use case versus special use case campaigns, see 10DLC Use Cases - Standard Use Cases vs Special Use Cases.

Enum: "2FA" "ACCOUNT_NOTIFICATION" "CUSTOMER_CARE" "DELIVERY_NOTIFICATION" "FRAUD_ALERT" "HIGHER_EDUCATION" "LOW_VOLUME" "MARKETING" "MIXED" "POLLING_VOTING" "PUBLIC_SERVICE_ANNOUNCEMENT" "SECURITY_ALERT" "AGENTS_FRANCHISES" "CARRIER_EXEMPT" "CHARITY" "EMERGENCY" "K12_EDUCATION" "POLITICAL" "PROXY" "SOCIAL" "SWEEPSTAKE"
campaignName
required
string <= 128 characters

This is an optional name to help track and view your campaign within Sinch's platform. Use a name that is easily recognizable, this will help you identify your campaign later within the Sinch customer dashboard. This name is not part of the campaign registration in TCR.

description
required
string [ 40 .. 4096 ] characters

Describe in detail the service the message program is providing to the end user and the purpose of the brand's messages (i.e. appointment reminders, OTP alerts, etc.). The description should match the selected use case and identify who is sending the messages, who is receiving the messages, and why messages are being sent.

sample1
required
string [ 20 .. 1024 ] characters

Provide sample production message content. Include the Brand name and opt out instructions (e.g. Reply STOP to stop) in every message. If you have selected Mixed use case, please provide examples of each sub use case selected.

sample2
required
string <= 1024 characters

Message sample. Some campaign tiers require 2 or more message samples, depending on sub-usecases.

sample3
required
string <= 1024 characters

Message sample. Some campaign tiers require 3 or more message samples, depending on sub-usecases.

stopMessage
required
string [ 20 .. 255 ] characters

Message sent in response to a STOP keyword. It must confirm that the end user has unsubscribed from the message program and will not receive any further messages. Include the brand name. You can also include customer care contact information (e.g. support email or phone number).

optInMessage
required
string [ 20 .. 255 ] characters

Initial message that is sent confirming the end user's subscription. Include the brand name, opt-out instructions (reply STOP to stop), customer care instructions (reply HELP for help), message frequency (#msgs/mo, msg frequency varies, recurring messages, etc.) and the "message and data rates may apply" disclosure (Msg & Data rates may apply).

helpMessage
required
string [ 20 .. 255 ] characters

Message sent in response to HELP. Include the brand name and additional customer care contact information (e.g. support email or phone number).

autoRenewal
required
boolean
Default: true

Will your campaign automatically renew? If "Yes", a monthly recurring fee will be charged to the account. If "No", only the initial setup fee will be charged, and the campaign will expire after three months unless it is reviewed manually.

embeddedLink
required
boolean
Default: false

Will your message content include a URL? Note that public URL shorteners are not allowed.

embeddedPhone
required
boolean
Default: false

Will your message content include embedded phone numbers?

numberPool
required
boolean
Default: false

Will your campaign support a number pool (more than 50 numbers)? If yes, your use case should clearly support the need for a number pool. For more info, see When should I use a number pool for my 10DLC campaign.

ageGated
required
boolean
Default: false

Will your traffic include any content related to age-restricted goods or services? If yes, you must implement an age gate verification process.

directLending
required
boolean
Default: false

Are you a financial institution engaged in direct, first-party lending to your customers? If yes, note that your campaign description should clearly indicate direct lending, even if your use case is not related to your lending services (e.g. OTP).

subscriberOptIn
required
boolean
Default: true

Will your campaign collect and process end user opt-ins? This is mandatory for all use cases, except for Machine-to-Machine.

subscriberOptOut
required
boolean
Default: true

Message sent in response to a STOP keyword. It must confirm that the end user has unsubscribed from the message program and will not receive any further messages. Include the brand name. You can also include customer care contact information (e.g. support email or phone number).

subscriberHelp
required
boolean
Default: true

Message sent in response to HELP. Include the brand name and additional customer care contact information (e.g. support email or phone number).

optinKeywords
required
string <= 255 characters

If subscribers can opt-in via a keyword, enter keyword(s) here (alphanumeric comma separated values, no blank spaces).

optoutKeywords
required
string <= 255 characters

Subscriber opt-out keywords. Default values are STOP, QUIT, END, CANCEL and UNSUBSCRIBE. If you accept additional opt-out keywords, you can enter them here (alphanumeric comma separated values, no blank spaces).

helpKeywords
required
string <= 255 characters

Subscriber help keywords. Default value is HELP. If you accept additional help keywords, you can enter them here. (alphanumeric comma separated values, no blank spaces).

messageFlow
required
string [ 40 .. 2048 ] characters

Provide instructions for how end users opt-in to receive messages. A compliant opt-in is critical to the approval of your campaign. Include all opt-in mechanisms (e.g. keyword/text-to-join, online form, point-of-sale (POS) system, verbal consent, interactive voice response (IVR) system, paper form) and a clear program description. The Call-to-Action should include opt-out instructions (reply STOP to stop), customer care instructions (reply HELP for help), message frequency (#msgs/mo, msg frequency varies, recurring messages, etc.) and message and data rates disclosure (Msg & Data rates may apply).

vertical
string (Campaign Vertical Type)
Deprecated

This field has been deprecated and is no longer being captured.

sample4
string <= 1024 characters

Message sample. Some campaign tiers require 4 or more message samples, depending on sub-usecases.

subUseCases
Array of strings (v1alpha1CampaignSubUseCaseType)

If you have selected a mixed use case, select all sub use cases that apply to your message program. Choose between 2 and 5 sub use cases for this campaign. The input(s) should be one of the accepted enum values.

Items Enum: "2FA" "ACCOUNT_NOTIFICATION" "CUSTOMER_CARE" "DELIVERY_NOTIFICATION" "FRAUD_ALERT" "HIGHER_EDUCATION" "MARKETING" "POLLING_VOTING" "PUBLIC_SERVICE_ANNOUNCEMENT" "SECURITY_ALERT"
Responses
200

A successful response.

Response Schema: application/json
campaignRegistrationId
string <= 26 characters

Sinch generated campaign ID (ULID format). Note that this is not the TCR campaign ID. The TCR Campaign ID will be available once the campaign has been approved and submitted to TCR.

400

INVALID_ARGUMENT: If the input parameters are not valid

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

post/v1/projects/{projectId}/campaignRegistrations:submit
Request samples
application/json
{
  • "brandId": "string",
  • "useCase": "2FA",
  • "campaignName": "string",
  • "description": "stringstringstringstringstringstringstri",
  • "sample1": "{Brand name}: We are contacting you today to let you know your order is ready for pickup. Reply STOP to stop.",
  • "sample2": "{Brand name}: Your confirmation code is SINCH1234. Please enter it on the authentication website. Reply STOP to stop.",
  • "sample3": "{Brand name}: Shop at www.example.com for all your retail needs! From clothing to home goods, we've got you covered. Visit us today and save! Reply STOP to stop. ",
  • "stopMessage": "You have been unsubscribed and will not receive any more messages from {Brand name}. For more information call {phone number} or email {email address}.",
  • "optInMessage": "You have opted in to receive messages from {Brand name}! Msg freq varies. Msg & data rates may apply. Reply HELP for help. Reply STOP to stop.",
  • "helpMessage": "{Brand name}: For help call {phone number} or email {email address} Reply STOP to stop.",
  • "autoRenewal": true,
  • "embeddedLink": false,
  • "embeddedPhone": false,
  • "numberPool": false,
  • "ageGated": false,
  • "directLending": false,
  • "subscriberOptIn": true,
  • "subscriberOptOut": true,
  • "subscriberHelp": true,
  • "optinKeywords": "Join,Subscribe,Agree",
  • "optoutKeywords": "Stop,Quit,Cancel",
  • "helpKeywords": "Help,Info",
  • "messageFlow": "Users will opt-in to receive messages from {Brand name} via {opt-in mechanism}"
}
Response samples
application/json
{
  • "campaignRegistrationId": "string"
}

Get Campaign Details

Returns the details of the specified campaign by its registration ID.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.

campaignRegistrationId
required
string

Campaign Registration Id returned by the create campaign API.

Responses
200

A successful response.

Response Schema: application/json
campaignId
string <= 7 characters

Campaign ID returned by external partner. i.e. TCR Campaign Id

campaignName
string <= 128 characters

Optional name to help track and view campaign.

campaignRegistrationId
string <= 26 characters

Campaign Registration Id returned by the Create Campaign API

createDate
string <date-time>

Campaign Creation Date

modifiedDate
string <date-time>

Campaign Modified Date

createdBy
string <= 20 characters

Represents who Created this Campaign

modifiedBy
string <= 20 characters

Represents who was the Last to Modify this Campaign

autoRenewal
boolean

Campaign subscription auto-renewal status.

billedDate
string <date-time>

Campaign recent billed date.

brandId
string <= 8 characters

Alphanumeric identifier of the brand associated with this campaign.

vertical
string <= 20 characters

Business/industry segment of this campaign. Must be of defined valid types.

useCase
string <= 20 characters

Campaign useCase.

subUseCases
Array of strings

Campaign sub use-cases.

description
string <= 4096 characters

Summary description of this campaign.

embeddedLink
boolean

Does message generated by the campaign include URL link in SMS?

embeddedPhone
boolean

Does message generated by the campaign include phone number in SMS?

affiliateMarketing
boolean

Does message content controlled by affiliate marketing other than the brand?

numberPool
boolean

Indicates whether this campaign has been approved and configured as a numberpool campaign

ageGated
boolean

Age gated content in campaign.

directLending
boolean

is direct lending.

subscriberOptIn
boolean

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptOut
boolean

Does campaign support subscriber opt-out keyword(s)?

subscriberHelp
boolean

Does campaign responds to help keyword(s)?

sample1
string <= 1024 characters

Message sample. Some campaign tiers require 1 or more message samples.

sample2
string <= 1024 characters

Message sample. Some campaign tiers require 2 or more message samples.

sample3
string <= 1024 characters

Message sample. Some campaign tiers require 3 or more message samples.

sample4
string <= 1024 characters

Message sample. Some campaign tiers require 4 or more message samples.

stopMessage
string <= 255 characters

Message that will be returned if a subscriber opts out of the campaign.

optInMessage
string <= 255 characters

Message that will be returned when a subscriber opts into a campaign.

helpMessage
string <= 255 characters

Help message of the campaign.

monthlyFee
number <float>

Monthly Fee

setupFee
number <float>

Initial Setup Fee

status
string <= 32 characters

Campaign Status.

  • SINCH_REVIEW: Campaign submitted successfully and awaiting approval from Sinch.
  • SINCH_APPROVED: Campaign approved by Sinch.
  • SINCH_REJECTED: Campaign rejected by Sinch.
  • SUBMITTED: Campaign submitted successfully to TCR and awaiting approval from operators
  • APPROVED: Campaign has been approved by the operators and is ready to be activated by adding a number to it.
  • ACTIVE: Campaign is active and running
  • EXPIRED: Campaign is expired. Traffic cannot be sent, cannot be reactivated
  • REJECTED: Campaign was rejected by one of the operators
  • SUBMISSION_FAILED: Campaign submission failed
object (Map of Metadata Map of MNO metadata where key is the 'networkId' of the MNO and value is Metadata of the MNO)
mock
boolean

Defines if campaign mocked or real one

lastActionStatus
string

Last Action Status.

  • CREATE_IN_PROGRESS: Creating campaign in TCR.
  • CREATE_SUCCESSFUL: Campaign created in TCR.
  • CREATE_FAILED: Campaign creation failed in TCR.
  • DELETE_IN_PROGRESS: Deleting campaign in TCR.
  • DELETE_SUCCESSFUL: Campaign deleted in TCR.
  • DELETE_FAILED: Campaign deletion failed in TCR.
optinKeywords
string <= 255 characters

Subscriber opt-in keywords. Must be upper-case alphanumeric comma(,) separated keywords without space.

optoutKeywords
string <= 255 characters

Subscriber opt-out keywords. Default value is 'STOP'. Must be upper-case alphanumeric comma(,) separated keywords without space.

helpKeywords
string <= 255 characters

Subscriber help keywords. Default value is 'HELP'. Must be upper-case alphanumeric comma(,) separated keywords without space.

messageFlow
string <= 2048 characters

Message flow description.

nextRenewalOrExpirationDate
string

When the campaign would be due for its next renew/bill date.

400

INVALID_ARGUMENT: If the input parameters are not valid

404

The campaign could not be found

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

get/v1/projects/{projectId}/campaignRegistrations/{campaignRegistrationId}
Request samples 
Response samples 
application/json
{
  • "campaignId": "string",
  • "campaignName": "string",
  • "campaignRegistrationId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "autoRenewal": true,
  • "billedDate": "2019-08-24T14:15:22Z",
  • "brandId": "string",
  • "vertical": "string",
  • "useCase": "string",
  • "subUseCases": [
    • "string"
    ],
  • "description": "string",
  • "embeddedLink": true,
  • "embeddedPhone": true,
  • "affiliateMarketing": true,
  • "numberPool": true,
  • "ageGated": true,
  • "directLending": true,
  • "subscriberOptIn": true,
  • "subscriberOptOut": true,
  • "subscriberHelp": true,
  • "sample1": "string",
  • "sample2": "string",
  • "sample3": "string",
  • "sample4": "string",
  • "stopMessage": "string",
  • "optInMessage": "string",
  • "helpMessage": "string",
  • "monthlyFee": 0.1,
  • "setupFee": 0.1,
  • "status": "string",
  • "mnoMetadata": {
    • "property1": {
      },
    • "property2": {
      }
    },
  • "mock": true,
  • "lastActionStatus": "string",
  • "optinKeywords": "string",
  • "optoutKeywords": "string",
  • "helpKeywords": "string",
  • "messageFlow": "string",
  • "nextRenewalOrExpirationDate": "string"
}
Get Campaign Details using the TCR Campaign ID
Returns the specified campaign by its TCR Campaign ID.


SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
query Parameters
campaignRegistrationIdQuery
required
string
Campaign Registration Id returned by the create campaign API.


 
Responses 
200
A successful response.


Response Schema: application/json
campaignId
string  <= 7 characters 
Campaign ID returned by external partner. i.e. TCR Campaign Id


 
campaignName
string  <= 128 characters 
Optional name to help track and view campaign.


 
campaignRegistrationId
string  <= 26 characters 
Campaign Registration Id returned by the Create Campaign API


 
createDate
string <date-time> 
Campaign Creation Date


 
modifiedDate
string <date-time> 
Campaign Modified Date


 
createdBy
string  <= 20 characters 
Represents who Created this Campaign


 
modifiedBy
string  <= 20 characters 
Represents who was the Last to Modify this Campaign


 
autoRenewal
boolean
Campaign subscription auto-renewal status.


 
billedDate
string <date-time> 
Campaign recent billed date.


 
brandId
string  <= 8 characters 
Alphanumeric identifier of the brand associated with this campaign.


 
vertical
string  <= 20 characters 
Business/industry segment of this campaign. Must be of defined valid types.


 
useCase
string  <= 20 characters 
Campaign useCase.


 
subUseCases
Array of strings
Campaign sub use-cases. 


 
description
string  <= 4096 characters 
Summary description of this campaign.


 
embeddedLink
boolean
Does message generated by the campaign include URL link in SMS?


 
embeddedPhone
boolean
Does message generated by the campaign include phone number in SMS?


 
affiliateMarketing
boolean
Does message content controlled by affiliate marketing other than the brand?


 
numberPool
boolean
Indicates whether this campaign has been approved and configured as a numberpool campaign


 
ageGated
boolean
Age gated content in campaign.


 
directLending
boolean
is direct lending.


 
subscriberOptIn
boolean
Does campaign require subscriber to opt-in before SMS is sent to subscriber?


 
subscriberOptOut
boolean
Does campaign support subscriber opt-out keyword(s)?


 
subscriberHelp
boolean
Does campaign responds to help keyword(s)?


 
sample1
string  <= 1024 characters 
Message sample. Some campaign tiers require 1 or more message samples.


 
sample2
string  <= 1024 characters 
Message sample. Some campaign tiers require 2 or more message samples.


 
sample3
string  <= 1024 characters 
Message sample. Some campaign tiers require 3 or more message samples.


 
sample4
string  <= 1024 characters 
Message sample. Some campaign tiers require 4 or more message samples.


 
stopMessage
string  <= 255 characters 
Message that will be returned if a subscriber opts out of the campaign.


 
optInMessage
string  <= 255 characters 
Message that will be returned when a subscriber opts into a campaign.


 
helpMessage
string  <= 255 characters 
Help message of the campaign.


 
monthlyFee
number <float> 
Monthly Fee


 
setupFee
number <float> 
Initial Setup Fee


 
status
string  <= 32 characters 
Campaign Status. 


    

  • SINCH_REVIEW: Campaign submitted successfully and awaiting approval from Sinch.
    • 

  • SINCH_APPROVED: Campaign approved by Sinch.
    • 

  • SINCH_REJECTED: Campaign rejected by Sinch.
    • 

  • SUBMITTED: Campaign submitted successfully to TCR and awaiting approval from operators
    • 

  • APPROVED: Campaign has been approved by the operators and is ready to be activated by adding a number to it.
    • 

  • ACTIVE: Campaign is active and running
    • 

  • EXPIRED: Campaign is expired. Traffic cannot be sent, cannot be reactivated
    • 

  • REJECTED: Campaign was rejected by one of the operators
    • 

  • SUBMISSION_FAILED: Campaign submission failed
    • 



 
object (Map of Metadata  Map of MNO metadata where key is the 'networkId' of the MNO and value is Metadata of the MNO) 
 
mock
boolean
Defines if campaign mocked or real one


 
lastActionStatus
string
Last Action Status. 


    

  • CREATE_IN_PROGRESS: Creating campaign in TCR.
    • 

  • CREATE_SUCCESSFUL: Campaign created in TCR.
    • 

  • CREATE_FAILED: Campaign creation failed in TCR.
    • 

  • DELETE_IN_PROGRESS: Deleting campaign in TCR.
    • 

  • DELETE_SUCCESSFUL: Campaign deleted in TCR.
    • 

  • DELETE_FAILED: Campaign deletion failed in TCR.
    • 



 
optinKeywords
string  <= 255 characters 
Subscriber opt-in keywords. Must be upper-case alphanumeric comma(,) separated keywords without space.


 
optoutKeywords
string  <= 255 characters 
Subscriber opt-out keywords. Default value is 'STOP'. Must be upper-case alphanumeric comma(,) separated keywords without space.


 
helpKeywords
string  <= 255 characters 
Subscriber help keywords. Default value is 'HELP'. Must be upper-case alphanumeric comma(,) separated keywords without space.


 
messageFlow
string  <= 2048 characters 
Message flow description.


 
nextRenewalOrExpirationDate
string
When the campaign would be due for its next renew/bill date.


 
400
INVALID_ARGUMENT: If the input parameters are not valid


404
The campaign could not be found


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId
Request samples 
Response samples 
application/json
{
  • "campaignId": "string",
  • "campaignName": "string",
  • "campaignRegistrationId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "autoRenewal": true,
  • "billedDate": "2019-08-24T14:15:22Z",
  • "brandId": "string",
  • "vertical": "string",
  • "useCase": "string",
  • "subUseCases": [
    • "string"
    ],
  • "description": "string",
  • "embeddedLink": true,
  • "embeddedPhone": true,
  • "affiliateMarketing": true,
  • "numberPool": true,
  • "ageGated": true,
  • "directLending": true,
  • "subscriberOptIn": true,
  • "subscriberOptOut": true,
  • "subscriberHelp": true,
  • "sample1": "string",
  • "sample2": "string",
  • "sample3": "string",
  • "sample4": "string",
  • "stopMessage": "string",
  • "optInMessage": "string",
  • "helpMessage": "string",
  • "monthlyFee": 0.1,
  • "setupFee": 0.1,
  • "status": "string",
  • "mnoMetadata": {
    • "property1": {
      },
    • "property2": {
      }
    },
  • "mock": true,
  • "lastActionStatus": "string",
  • "optinKeywords": "string",
  • "optoutKeywords": "string",
  • "helpKeywords": "string",
  • "messageFlow": "string",
  • "nextRenewalOrExpirationDate": "string"
}
Qualify Brand by Use Case
Before submitting a campaign, this API will provide some important feedback about how the resulting campaign will be treated.  You can verify that the campaign will be supported by all operators, the AT&T message class and TPM, the T-Mobile brand daily bucket that will be applied and more.


It is suggested to validate that the operator restrictions will meet your needs prior to submitting the campaign request.  Brand revettings do not automatically adjust operator restrictions, and in some cases a new campaign may have to be resubmitted to receive the adjusted MNO values.


SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
query Parameters
brandId
required
string
Brand Id to be qualified


 
useCase
string
The desired Use Case.


 
Responses 
200
A successful response.


Response Schema: application/json
useCase
string
Desired useCase.


 
monthlyFee
number <float> 
Monthly registration fee for campaign. If auto-renew is selected on a campaign, this recurring fee will be charged monthly starting three months after the campaign is submitted.


 
setupFee
number <float> 
Initial setup fee, charged immediately once the campaign has been approved by Sinch and submitted to partners.  This fee covers the first three months of campaign use, and will be charged whether or not the autoRenewal parameter is set on the campaign.


 
minSubUseCases
number
Minimum number of sub use-cases required when registering a campaign with the desired use case.


 
maxSubUseCases
number
Maximum number of sub use-cases required when registering a campaign with the desired use case.


 
object (Map of Metadata  Map of MNO metadata where key is the 'networkId' of the MNO and value is Metadata of the MNO) 
 
400
Invalid Brand ID


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/campaignRegistrations:qualify
Request samples 
Response samples 
application/json
{
  • "useCase": "string",
  • "monthlyFee": 0.1,
  • "setupFee": 0.1,
  • "minSubUseCases": 0,
  • "maxSubUseCases": 0,
  • "mnoMetadata": {
    • "property1": {
      },
    • "property2": {
      }
    }
}
Delete Campaign by campaignId
Deactivate a campaign by removing the campaign from TCR and OSR. A campaign cannot be restored once it is deactivated. New campaign status is EXPIRED.


SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
campaignRegistrationId
required
string
Campaign Registration Id returned by the create campaign API.


 
Responses 
200
A successful response.


Response Schema: application/json
object
 
400
INVALID_ARGUMENT: If the input parameters are not valid


404
The campaign could not be found


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


delete/v1/projects/{projectId}/campaignRegistration/{campaignRegistrationId}
Request samples 
Response samples 
application/json
{ }
List Campaign Registrations
Lists all campaign registrations per project.


SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
query Parameters
status
Array of strings
 
mock
boolean
 
useCase
string
The desired Use Case.


 
brand
string
 
pageSize
integer <int32> 
 
pageToken
string
 
orderBy
string
 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (Campaign Response) 
 
nextPageToken
string
 
totalSize
integer <int32> 
 
400
If the page_token, number_pattern or order_by is not valid


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/campaignRegistrations
Request samples 
Response samples 
application/json
{
  • "campaignRegistrations": [
    • {
      }
    ],
  • "nextPageToken": "string",
  • "totalSize": 0
}
Campaign Registration Feedback
Returns feedback information for campaign registrations that were rejected.
Campaign registrations could be rejected due to TCR error or any other internal error.


SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
campaignRegistrationId
required
string
Campaign Registration Id returned by the create campaign API.


 
Responses 
200
A successful response.


Response Schema: application/json
campaignRegistrationId
string
 
campaignId
string
 
status
string
 
Array of objects (v1alpha1TcrErrorResponse) 
 
Array of objects (v1alpha1InternalErrorResponse) 
 
400
INVALID_ARGUMENT: If the input parameters are not valid


404
The campaign could not be found or if the requested campaign does not belong to the given project


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


get/v1/projects/{projectId}/campaignRegistrations/{campaignRegistrationId}/feedback
Request samples 
Response samples 
application/json
{
  • "campaignRegistrationId": "string",
  • "campaignId": "string",
  • "status": "string",
  • "tcrErrorResponse": [
    • {
      }
    ],
  • "internalErrorResponse": [
    • {
      }
    ]
}
Campaign Registration Resubmit
"Resubmit a campaign to:


    

  1. Backfill missing MNO campaign operation records for one or more networks.
    2. 

  2. Retroactively update the campaign to reflect newly assigned message class.
    3. 



Please note that running this endpoint could potentially downgrade campaign business terms.


After hitting this endpoint, call the Get Campaign Registration API to to check lastActionStatus:


    

  1. If lastActionStatus is RESUBMIT_IN_PROGRESS, mno metadata not updated, poll again.
    2. 

  2. If lastActionStatus is RESUBMIT_SUCCESSFUL, get updated MNO metadata.
    3. 

  3. If lastActionStatus is RESUBMIT_FAILED, call the Campaign Feedback API to know the reason for failure.
    4. 



SecurityBasicAuth or OAuth2 
Request 
path Parameters
projectId
required
string
Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.


 
campaignRegistrationId
required
string
Campaign Registration Id returned by the create campaign API.


 
Request Body schema: application/json
optional
List of MNOs (ATT, TMO, USC, VZW) to resubmit a campaign in TCR. Default value for empty list: ALL, i.e. all MNOs.


mnos
Array of strings
 
Responses 
200
A successful response.


Response Schema: application/json
object
 
400
INVALID_ARGUMENT: If the input parameters are not valid


404
The campaign could not be found or if the requested campaign does not belong to the given project


429
Over limit


500
INTERNAL: Internal server error. Typically, a server bug.


put/v1/projects/{projectId}/campaignRegistrations/{campaignRegistrationId}/resubmit
Request samples 
application/json
{ }
Response samples 
application/json
{ }
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.