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

TNID API documentation Company Ten dlc List 10DLC campaigns

List 10DLC campaigns

On this page

GraphQL endpoint: /company

List all the 10DLC Campaigns the company has access to.

The company has access to their own campaigns as well as any other campaigns from companies that have authorized 10DLC actions to the company.

Query

query($brandId: String, $companyId: ID, $status: TenDlcCampaignStatus, $workflowStatus: TenDlcCampaignWorkflowStatus, $usecase: String, $ownershipType: TenDlcOwnershipType, $page: Int, $pageSize: Int) {
  tenDlcCampaigns(brandId: $brandId, companyId: $companyId, status: $status, workflowStatus: $workflowStatus, usecase: $usecase, ownershipType: $ownershipType, page: $page, pageSize: $pageSize) {
    page
    totalRecords
    records {
      campaignId
      companyId
      brandId
      usecase
      workflowStatus
      status
      description
      autoRenewal
      ownershipType
    }
  }
}

Variables

{}

Response

{
  "data": {
    "tenDlcCampaigns": {
      "page": 1,
      "records": [
        {
          "autoRenewal": true,
          "brandId": "BTEST1",
          "campaignId": "CCRR25G",
          "companyId": "00000000-0000-4000-8000-000000000001",
          "description": "Test marketing campaign for product launches and promotions",
          "ownershipType": "DIRECT",
          "status": "ACTIVE",
          "usecase": "MARKETING",
          "workflowStatus": "VERIFIED"
        },
        {
          "autoRenewal": false,
          "brandId": "BTEST1",
          "campaignId": "CVSF76W",
          "companyId": "00000000-0000-4000-8000-000000000001",
          "description": "Test customer care campaign for support and inquiries",
          "ownershipType": "DIRECT",
          "status": "DRAFT",
          "usecase": "CUSTOMER_CARE",
          "workflowStatus": "DRAFT"
        },
        {
          "autoRenewal": false,
          "brandId": "BTEST2",
          "campaignId": "CKEM6W3",
          "companyId": "00000000-0000-4000-8000-000000000001",
          "description": "Test customer care campaign for support and inquiries",
          "ownershipType": "PARTNER",
          "status": "DRAFT",
          "usecase": "CUSTOMER_CARE",
          "workflowStatus": "DRAFT"
        }
      ],
      "totalRecords": 3
    }
  }
}