Register a campaign
Registers a campaign for one of your brands: what you send, how recipients consent, and how HELP and STOP behave. With two or more brands, name the brand with brand_id. When the registry accepts the campaign, Resia charges its first month; each later month is charged on the same day of the month until you release the campaign with DELETE /v1/10dlc/campaigns/{campaign_id}. If the registry rejects it, Resia charges a one-time rejection fee and no later month. Charges are not refunded. The request must repeat the monthly_fee from the use-case listing as confirmed_upfront_fee; if Resia's price no longer matches, nothing is charged and the answer is 409. A balance of $0.00 or less answers 402. Idempotency-Key is optional and makes any retry safe: the same key returns the original registration (recovering it even when the first response was lost) and never charges twice; reusing the key with changed content returns 409. Without a key, each request is a new submission, so a retry can register and charge twice, and a submission whose first response was lost stays pending. Registry and carrier review then run for hours to days — follow progress with GET /v1/10dlc/campaigns/{campaign_id}. Resia has no daily campaign submission limit.
Headers
- Type: stringIdempotency
- Key min length:1max length:255nullableOptional. Repeat this value to retry safely: the same key returns the original registration instead of charging again.
- Type: stringnullableX
- Resia - Organization - Id For Resia staff only. Omit it: your key acts on your own organization.
Body·
- Type: stringconfirmed
_upfront _fee requiredThe
monthly_feeshown in the qualification listing: the first month, charged when the registry accepts the campaign. Submission is refused if Resia's price no longer matches. - Type: stringdescriptionmin length:40max length:4096required
What this campaign's messages are about, for registry reviewers.
- Type: stringhelp
_message min length:20max length:320requiredThe reply a recipient gets after texting a help keyword.
- Type: stringmessage
_flow min length:40max length:2048requiredHow a recipient consents to these messages, step by step.
- Type: stringoptout
_message min length:20max length:320requiredThe final reply a recipient gets after opting out.
- Type: stringprivacy
_policy _link max length:255requiredPublic privacy-policy URL.
- Type: array of string 1…5sample
_messages min length:1max length:1024requiredOne to five representative message texts.
- Type: stringterms
_and _conditions _link max length:255requiredPublic terms-and-conditions URL.
- Type: enumusecaserequired
The use case to register, from the qualification listing.
values- 2
F A - A
C C O U N T _ N O T I F I C A T I O N - A
G E N T S _ F R A N C H I S E S - C
H A R I T Y - C
U S T O M E R _ C A R E - D
E L I V E R Y _ N O T I F I C A T I O N - E
M E R G E N C Y - F
R A U D _ A L E R T
- 2
- Type: booleanage
_gated Whether the content is age-restricted.
- Type: stringnullablebrand
_id The brand to register the campaign under. Optional when the organization has one brand; required when it has two or more.
- Type: booleandirect
_lending Whether messages relate to direct lending or loan arrangements.
Responses
- application/json
- application/json
curl https://api.resia.ai/v1/10dlc/campaigns \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"brand_id": "4b20017f-8da9-a992-a6c0-683072fb7729",
"usecase": "LOW_VOLUME",
"description": "",
"sample_messages": [
""
],
"message_flow": "",
"help_keywords": "HELP",
"help_message": "",
"optin_keywords": "",
"optin_message": "",
"optout_keywords": "STOP",
"optout_message": "",
"privacy_policy_link": "",
"terms_and_conditions_link": "",
"age_gated": false,
"direct_lending": false,
"embedded_link": false,
"embedded_phone": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"sub_usecases": [
"ACCOUNT_NOTIFICATION"
],
"confirmed_upfront_fee": "6.00"
}'
{
"campaign_id": "6d40039b-0fc1-c114-c8e2-8a5294fd9941",
"status": "registered"
}
