API Reference
  1. Ekas API
  2. Campaigns

Create a campaign

post
https://app.ekas.io/v1/campaigns

Create a 10DLC messaging campaign under a brand. Phone numbers are managed through the /campaigns/{id}/phone-numbers sub-resource; the optional phone_numbers array on create is a convenience for initial association.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a stored campaign.

string
required
string
enum
required

TCR campaign use case. The legacy /compliance/check alias also accepts these values case-insensitively.

sub_use_cases
array of objects
length between 2 and 5

Required (2-5) for mixed and low_volume.

sub_use_cases
string
required
sample_messages
array of strings
required
length between 1 and 5
sample_messages*
string
required
opt_in
object
opt_out
object

Keywords and the auto-response message (used for opt-out and help).

help
object

Keywords and the auto-response message (used for opt-out and help).

attributes
object

TCR campaign attribute flags.

uri
uri
string
boolean
Defaults to true
phone_numbers
array of strings

Convenience — initial numbers to associate (also manageable via the sub-resource).

phone_numbers
metadata
object

Free-form string map (≤50 keys, values ≤500 chars). Filterable on list endpoints.

Headers
string
length ≤ 255

Any unique string (e.g. a UUID). Retries with the same key within 24h return the original response with Idempotent-Replayed: true. Same key + different body → 409.

string

Scope this request (and the created resource) to a subaccount.

Responses

Updated 1 day ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?