TSGGLOBAL Support sign in
Skip to page content
Browse TNID API docs

TNID API documentation Company Ten dlc Register and submit 10DLC campaign

Register and submit 10DLC campaign

On this page

GraphQL endpoint: /company

Register a new 10DLC campaign and submit it for approval. This action submits the campaign directly to TCR for approval. Once the campaign is submitted its status is PENDING, and once approved by TCR it changes to ACTIVE.

A campaign's status is one of DRAFT, PENDING, ACTIVE, ERROR, EXPIRED or SUSPENDED. Note that these are the campaign's own statuses — a brand's are different, and PENDING_REVIEW is one of those.

Query

mutation($input: TenDlcRegisterCampaignInput!) {
  registerAndSubmitTenDlcCampaign(input: $input) {
    campaignId
    companyId
    brandId
    usecase
    status
    description
    messageFlow
    autoRenewal
  }
}

Variables

{
  "input": {
    "description": "Test marketing campaign for product launches and promotions",
    "internalBrandId": "00000000-0000-4000-8000-000000000003",
    "messageFlow": "Users opt-in by texting JOIN to our number. They receive updates about new products.",
    "nnid": "test-nnid-001",
    "resellerId": "CSP12345",
    "sample1": "Welcome! Reply STOP to unsubscribe, HELP for assistance.",
    "subscriberHelp": true,
    "subscriberOptin": true,
    "subscriberOptout": true,
    "tenDlcApiKeyId": "00000000-0000-4000-8000-000000000002",
    "termsAndConditions": true,
    "usecase": "MARKETING"
  }
}

Response

{
  "data": {
    "registerAndSubmitTenDlcCampaign": {
      "autoRenewal": true,
      "brandId": "B6MSXT4",
      "campaignId": "C160379",
      "companyId": "00000000-0000-4000-8000-000000000001",
      "description": "Test marketing campaign for product launches and promotions",
      "messageFlow": "Users opt-in by texting JOIN to our number. They receive updates about new products.",
      "status": "ACTIVE",
      "usecase": "MARKETING"
    }
  }
}