Update a campaign form

Change the fields of the account's 10DLC campaign form; fields left out keep their value. The form must belong to the account, and the account must already have a brand form. The registration cannot be changed through this endpoint (a registration object in the body is ignored), but setting status to completed submits the form, which moves the registration to in-review. Requires the SMS registration permission.

Path Params
integer
required

The campaign form id; it must belong to the account.

Body Params

The campaign form fields to change. Every field is optional; a field left out keeps its value. Only the form's own fields can be set: the registration object is read-only and is ignored when sent.

string
enum

The form status to set.

Allowed:
string | null
enum

The campaign use case. Null picks the default for the brand type.

Allowed:
string

How SMS is used for this campaign.

boolean

Whether the messages contain phone numbers.

message_samples
array of strings

Sample messages for the campaign.

message_samples
string | null

Link to the Privacy Policy, or to a screenshot of it.

string | null

Link to the Terms of Service, or to a screenshot of them.

string | null

Public website whose form collects opt-ins with a checkbox.

string | null

Link to a screenshot of the opt-in form when the website is not public.

string | null

Link to a public document with screenshots of the keyword opt-in.

string | null

The opt-in URL when the generic opt-in method is chosen.

string | null

Link to a screenshot of the paper opt-in form.

Responses

403

The user may not manage SMS registration.

422

A field failed validation; the response lists the validation errors.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json