Skip to content
DashboardGet API key

Sync 10DLC campaign status

View .md
POST

Sync the campaign status with the registration provider. Use this to check for approval updates after submission.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • campaignIdstringrequired

    10DLC campaign ID.

Responses

200Campaign status synced.
  • campaignobjectrequired
    29 properties
    • idstringrequired
    • brandIdstringrequired

      ID of the brand this campaign belongs to.

    • namestringrequired
    • useCasestringrequired

      Campaign use case type.

    • subUseCasesstring[]nullable
    • descriptionstringrequired

      Description of the messaging campaign.

    • sampleMessagesstring[]required

      Sample messages representative of campaign content.

    • subscriberOptInbooleanrequired
    • subscriberOptOutbooleanrequired
    • subscriberHelpbooleanrequired
    • numberPoolingbooleanrequired
    • directLendingbooleanrequired
    • embeddedLinkbooleanrequired
    • embeddedPhonebooleanrequired
    • affiliateMarketingbooleanrequired
    • ageGatedbooleanrequired
    • messageFlowstringnullable
    • helpMessagestringnullable
    • optInKeywordsstring[]nullable
    • optOutKeywordsstring[]nullable
    • statusstringrequired

      Status of a 10DLC campaign registration.

      • draft: created, not yet submitted.
      • pending: submitted, awaiting the carriers. Re-read from the carrier every 30 minutes, so it moves on its own.
      • approved: SMS to +1 numbers can go out from numbers assigned to it. The monthly fee is charged while it is approved.
      • rejected: refused by the carriers. The one-time registration fee is refunded.
      • failed: the registration did not reach the carriers. The fee is refunded.
      • expired: was approved and has lapsed.
      One ofdraftpendingapprovedrejectedexpiredfailed
    • dailyLimitintegernullable

      Daily message limit based on brand trust score.

    • failureReasonstringnullable
    • registrationCostCentsintegernullable

      One-time registration cost in cents.

    • monthlyFeeCentsintegernullable

      Recurring monthly fee in cents.

    • submittedAtstring<date-time>nullable
    • approvedAtstring<date-time>nullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
400Campaign has not been submitted yet.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Campaign not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject