Update SMS campaign

put

https://{region}-api.dotdigital.com/v2/sms/campaigns/{campaignId}

Updates an existing SMS campaign, as long as the campaign has not been sent.

Path Params

campaignId

integer

required

The ID of the campaign.

Body Params

name

string

required

length ≤ 255

The name of the SMS campaign that is being created. Maximum: 255 characters.

message

string

required

length ≤ 1600

The message content of the SMS campaign that is being created.

sendingIdentity

string

length ≤ 15

The sending identity (From name) to use in the SMS campaign. If a sending identity is specified, it must exist on your account as a sending identity (found in ''SMS from names''). If you don''t specify a sending identity, the default identity from your account is used for this SMS campaign. Maximum: 15 characters.

toggleShortLinks

boolean

Defines whether or not the new campaign is going to shorten links within the SMS content. If specified as true, it validates all links in the SMS message to look for any formatting errors. If errors are found, an error is returned.

Headers

x-ddg-integration-token

string

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad request