Skip to main content
POST
Create Campaign Registration

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for submitting an A2P SMS campaign registration.

sample_messages
string[]
required

Sample SMS messages for the campaign

Minimum array length: 1

How end-users consent to receiving messages

Whether consent was obtained from all recipients

proof_attachment_id
string | null

Attachment ID for uploaded consent proof

proof_url
string | null

External URL to consent proof

privacy_policy_url
string | null

URL to the customer's privacy policy

terms_and_conditions_url
string | null

URL to the customer's terms and conditions

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
sample_messages
string[]
required

Sample SMS messages for the campaign

How end-users consent to receiving messages

proof_attachment_id
string | null
required

Attachment ID for uploaded consent proof document

proof_url
string | null
required

External URL to consent proof (alternative to file upload)

privacy_policy_url
string | null
required

URL to the customer's privacy policy

terms_and_conditions_url
string | null
required

URL to the customer's terms and conditions

Whether the user has attested that consent was obtained from all recipients

user_id
string
required

User who submitted the registration

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.