Shared Campaigns

Update Single Shared Campaign

Changed on

Update campaign details by campaignId. Please note: Only webhook urls are editable.

patch/10dlc/partner_campaigns/{campaignId}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/partner_campaigns/{campaignId}
  • Auth: HTTP bearer

Path parameters

campaignIdstring required

Unique identifier of the campaign.

Request body

webhookURLstring

Webhook to which campaign status updates are sent.

webhookFailoverURLstring

Webhook failover to which campaign status updates are sent.

Example request

{
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "webhookFailoverURL": "https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6"
}

Response

Successful Response

ageGatedboolean

Age gated content in campaign.

assignedPhoneNumbersCountnumber

Number of phone numbers associated with the campaign

brandDisplayNamestring

Display or marketing name of the brand.

campaignStatus'TCR_PENDING' | 'TCR_SUSPENDED' | 'TCR_EXPIRED' | 'TCR_ACCEPTED' | 'TCR_FAILED' | 'TELNYX_ACCEPTED' | 'TELNYX_FAILED' | 'MNO_PENDING' | 'MNO_ACCEPTED' | 'MNO_REJECTED' | 'MNO_PROVISIONED' | 'MNO_PROVISIONING_FAILED'

Campaign status

descriptionstring

Summary description of this campaign.

directLendingboolean

Direct lending or loan arrangement.

embeddedLinkboolean

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

embeddedLinkSamplestring

Sample of an embedded link that will be sent to subscribers.

embeddedPhoneboolean

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

failureReasonsstring

Failure reasons if campaign submission failed

helpKeywordsstring

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessagestring

Help message of the campaign.

isNumberPoolingEnabledboolean

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

messageFlowstring

Message flow description.

numberPoolboolean

Does campaign utilize pool of phone numbers?

optinKeywordsstring

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

optinMessagestring

Subscriber opt-in message.

optoutKeywordsstring

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

optoutMessagestring

Subscriber opt-out message.

privacyPolicyLinkstring

Link to the campaign's privacy policy.

usecasestring

Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.

sample1string

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

sample2string

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

sample3string

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

sample4string

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

sample5string

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

subUsecasesstring[]

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases

subscriberOptinboolean

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

subscriberOptoutboolean

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

tcrBrandIdstring required

Unique identifier assigned to the brand by the registry.

tcrCampaignIdstring required

Unique identifier assigned to the campaign by the registry.

termsAndConditionsboolean

Is terms & conditions accepted?

termsAndConditionsLinkstring

Link to the campaign's terms and conditions.

webhookURLstring

Webhook to which campaign status updates are sent.

webhookFailoverURLstring

Failover webhook to which campaign status updates are sent.

createdAtstring

Date and time that the brand was created at.

updatedAtstring

Date and time that the brand was last updated at.

Example response

{
  "assignedPhoneNumbersCount": 3,
  "brandDisplayName": "ABC Mobile",
  "campaignStatus": "TCR_ACCEPTED",
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMP1",
  "webhookURL": "https://example.com/webhook",
  "webhookFailoverURL": "https://example.com/failover-webhook",
  "createdAt": "2021-03-08T17:57:48.801186",
  "updatedAt": "2021-03-08T17:57:48.801186"
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status