Update campaign

PUT

10dlc

campaign

{campaignId}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const telnyxCampaignCsp = await client.messaging10dlc.campaign.update('campaignId');

console.log(telnyxCampaignCsp.brandId);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
telnyx_campaign_csp = client.messaging_10dlc.campaign.update(
    campaign_id="campaignId",
)
print(telnyx_campaign_csp.brand_id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	telnyxCampaignCsp, err := client.Messaging10dlc.Campaign.Update(
		context.TODO(),
		"campaignId",
		telnyx.Messaging10dlcCampaignUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", telnyxCampaignCsp.BrandID)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignUpdateParams;
import com.telnyx.sdk.models.messaging10dlc.campaign.TelnyxCampaignCsp;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TelnyxCampaignCsp telnyxCampaignCsp = client.messaging10dlc().campaign().update("campaignId");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $telnyxCampaignCsp = $client->messaging10dlc->campaign->update(
    'campaignId',
    autoRenewal: true,
    helpMessage: 'helpMessage',
    messageFlow: 'messageFlow',
    resellerID: 'resellerId',
    sample1: 'sample1',
    sample2: 'sample2',
    sample3: 'sample3',
    sample4: 'sample4',
    sample5: 'sample5',
    webhookFailoverURL: 'webhookFailoverURL',
    webhookURL: 'webhookURL',
  );

  var_dump($telnyxCampaignCsp);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PUT \
  --url https://api.telnyx.com/v2/10dlc/campaign/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resellerId": "RESELLER",
  "sample1": "Sample1",
  "sample2": "Sample2",
  "sample3": "Sample3",
  "sample4": "Sample4",
  "sample5": "Sample5",
  "messageFlow": "Messageflow",
  "helpMessage": "Helpmessage",
  "autoRenewal": true,
  "webhookURL": "WebhookURL",
  "webhookFailoverURL": "WebhookURL"
}
'

{
  "brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
  "campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
  "cspId": "<string>",
  "description": "<string>",
  "mock": true,
  "subUsecases": [
    "<string>"
  ],
  "termsAndConditions": true,
  "usecase": "<string>",
  "ageGated": true,
  "autoRenewal": true,
  "billedDate": "<string>",
  "brandDisplayName": "ABC Mobile",
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMP1",
  "createDate": "<string>",
  "directLending": true,
  "embeddedLink": true,
  "embeddedPhone": true,
  "helpKeywords": "<string>",
  "helpMessage": "<string>",
  "messageFlow": "<string>",
  "nextRenewalOrExpirationDate": "<string>",
  "numberPool": true,
  "optinKeywords": "<string>",
  "optinMessage": "<string>",
  "optoutKeywords": "<string>",
  "optoutMessage": "<string>",
  "referenceId": "<string>",
  "resellerId": "<string>",
  "sample1": "<string>",
  "sample2": "<string>",
  "sample3": "<string>",
  "sample4": "<string>",
  "sample5": "<string>",
  "status": "<string>",
  "subscriberHelp": true,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "vertical": "<string>",
  "webhookURL": "https://example.com/webhook",
  "webhookFailoverURL": "https://example.com/failover-webhook",
  "isTMobileRegistered": true,
  "isTMobileSuspended": true,
  "isTMobileNumberPoolingEnabled": true,
  "failureReasons": "<string>",
  "submissionStatus": "CREATED",
  "campaignStatus": "TCR_ACCEPTED",
  "privacyPolicyLink": "<string>",
  "termsAndConditionsLink": "<string>",
  "embeddedLinkSample": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId

string

required

Unique identifier of the campaign.

Body

application/json

resellerId

string

Alphanumeric identifier of the reseller that you want to associate with this campaign.

Maximum string length: 8

sample1

string

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

Maximum string length: 255

sample2

string

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

Maximum string length: 255

sample3

string

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

Maximum string length: 255

sample4

string

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

Maximum string length: 255

sample5

string

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

Maximum string length: 255

messageFlow

string

Message flow description.

Maximum string length: 2048

helpMessage

string

Help message of the campaign.

Maximum string length: 255

autoRenewal

boolean

default:true

Help message of the campaign.

webhookURL

string

Webhook to which campaign status updates are sent.

webhookFailoverURL

string

Webhook failover to which campaign status updates are sent.

Response

Successful Response

Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including usecase, vertical, brandId and cspId.

brandId

string

required

Unique identifier assigned to the brand.

Example:

"d2ca9d69-641b-4131-83fa-5d0744f4c8a9"

campaignId

string

required

Unique identifier for a campaign.

Example:

"823d6b1a-6ed6-41a3-9c50-c8ff41b682ba"

cspId

string

required

Alphanumeric identifier of the CSP associated with this campaign.

description

string

required

Summary description of this campaign.

mock

boolean

required

Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.

subUsecases

string[]

required

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

termsAndConditions

boolean

required

Is terms & conditions accepted?

usecase

string

required

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

ageGated

boolean

Age gated content in campaign.

autoRenewal

boolean

Campaign subscription auto-renewal status.

billedDate

string

Campaign recent billed date.

brandDisplayName

string

Display or marketing name of the brand.

Example:

"ABC Mobile"

tcrBrandId

string

Unique identifier assigned to the brand by the registry.

Example:

"BBRAND1"

tcrCampaignId

string

Unique identifier assigned to the campaign by the registry.

Example:

"CCAMP1"

createDate

string

Unix timestamp when campaign was created.

directLending

boolean

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?

helpKeywords

string

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

helpMessage

string

Help message of the campaign.

messageFlow

string

Message flow description.

nextRenewalOrExpirationDate

string

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

numberPool

boolean

Does campaign utilize pool of phone numbers?

optinKeywords

string

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

optinMessage

string

Subscriber opt-in message.

optoutKeywords

string

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

optoutMessage

string

Subscriber opt-out message.

referenceId

string

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

resellerId

string

Alphanumeric identifier of the reseller that you want to associate with this campaign.

sample1

string

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

sample2

string

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

sample3

string

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

sample4

string

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

sample5

string

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

status

string

Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

subscriberHelp

boolean

Does campaign responds to help keyword(s)?

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)?

vertical

string

deprecated

Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.

This field is deprecated.

webhookURL

string

Webhook to which campaign status updates are sent.

Example:

"https://example.com/webhook"

webhookFailoverURL

string

Failover webhook to which campaign status updates are sent.

Example:

"https://example.com/failover-webhook"

isTMobileRegistered

boolean

Indicates whether the campaign is registered with T-Mobile.

isTMobileSuspended

boolean

Indicates whether the campaign is suspended with T-Mobile.

isTMobileNumberPoolingEnabled

boolean

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

failureReasons

string

Failure reasons if campaign submission failed

submissionStatus

enum<string>

Campaign submission status

Available options:

CREATED,

FAILED,

PENDING

campaignStatus

enum<string>

Campaign status

Available options:

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

Example:

"TCR_ACCEPTED"

privacyPolicyLink

string

Link to the campaign's privacy policy.

termsAndConditionsLink

string

Link to the campaign's terms and conditions.

embeddedLinkSample

string

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

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const telnyxCampaignCsp = await client.messaging10dlc.campaign.update('campaignId');

console.log(telnyxCampaignCsp.brandId);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
telnyx_campaign_csp = client.messaging_10dlc.campaign.update(
    campaign_id="campaignId",
)
print(telnyx_campaign_csp.brand_id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	telnyxCampaignCsp, err := client.Messaging10dlc.Campaign.Update(
		context.TODO(),
		"campaignId",
		telnyx.Messaging10dlcCampaignUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", telnyxCampaignCsp.BrandID)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messaging10dlc.campaign.CampaignUpdateParams;
import com.telnyx.sdk.models.messaging10dlc.campaign.TelnyxCampaignCsp;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TelnyxCampaignCsp telnyxCampaignCsp = client.messaging10dlc().campaign().update("campaignId");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $telnyxCampaignCsp = $client->messaging10dlc->campaign->update(
    'campaignId',
    autoRenewal: true,
    helpMessage: 'helpMessage',
    messageFlow: 'messageFlow',
    resellerID: 'resellerId',
    sample1: 'sample1',
    sample2: 'sample2',
    sample3: 'sample3',
    sample4: 'sample4',
    sample5: 'sample5',
    webhookFailoverURL: 'webhookFailoverURL',
    webhookURL: 'webhookURL',
  );

  var_dump($telnyxCampaignCsp);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PUT \
  --url https://api.telnyx.com/v2/10dlc/campaign/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resellerId": "RESELLER",
  "sample1": "Sample1",
  "sample2": "Sample2",
  "sample3": "Sample3",
  "sample4": "Sample4",
  "sample5": "Sample5",
  "messageFlow": "Messageflow",
  "helpMessage": "Helpmessage",
  "autoRenewal": true,
  "webhookURL": "WebhookURL",
  "webhookFailoverURL": "WebhookURL"
}
'

{
  "brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
  "campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
  "cspId": "<string>",
  "description": "<string>",
  "mock": true,
  "subUsecases": [
    "<string>"
  ],
  "termsAndConditions": true,
  "usecase": "<string>",
  "ageGated": true,
  "autoRenewal": true,
  "billedDate": "<string>",
  "brandDisplayName": "ABC Mobile",
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMP1",
  "createDate": "<string>",
  "directLending": true,
  "embeddedLink": true,
  "embeddedPhone": true,
  "helpKeywords": "<string>",
  "helpMessage": "<string>",
  "messageFlow": "<string>",
  "nextRenewalOrExpirationDate": "<string>",
  "numberPool": true,
  "optinKeywords": "<string>",
  "optinMessage": "<string>",
  "optoutKeywords": "<string>",
  "optoutMessage": "<string>",
  "referenceId": "<string>",
  "resellerId": "<string>",
  "sample1": "<string>",
  "sample2": "<string>",
  "sample3": "<string>",
  "sample4": "<string>",
  "sample5": "<string>",
  "status": "<string>",
  "subscriberHelp": true,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "vertical": "<string>",
  "webhookURL": "https://example.com/webhook",
  "webhookFailoverURL": "https://example.com/failover-webhook",
  "isTMobileRegistered": true,
  "isTMobileSuspended": true,
  "isTMobileNumberPoolingEnabled": true,
  "failureReasons": "<string>",
  "submissionStatus": "CREATED",
  "campaignStatus": "TCR_ACCEPTED",
  "privacyPolicyLink": "<string>",
  "termsAndConditionsLink": "<string>",
  "embeddedLinkSample": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Sending Messages

Messaging Profiles

Short Code

Hosted Numbers

Opt Outs

Phone Numbers

Toll Free Verification

10 DLC

For AI Agents

Update campaign

Authorizations

Path Parameters

Body

Response