v2
a2p-registration

Register Campaign

Register an A2P campaign under an existing brand.

Creates a Messaging Service and A2P Campaign in Twilio. The brand must be in APPROVED, PENDING, or IN_REVIEW state.

post/v2/a2p/campaign

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

mentium-workspace-idstring nullable

Request body

brand_registration_idstring required
usecasestring required

MIXED, MARKETING, CUSTOMER_CARE, DELIVERY_NOTIFICATIONS, etc.

descriptionstring required

Description of what this campaign does

message_flowstring required

How end-users opt in to receive messages

message_samplesstring[] required

1-5 sample messages

opt_in_messagestring required
opt_out_messagestring
help_messagestring
has_embedded_linksboolean
has_embedded_phoneboolean

Response

Successful Response

idstring required
brand_registration_idstring required
statusstring required
usecasestring required
descriptionstring required
failure_reasonstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.