Check a 10DLC campaign

post

https://app.ekas.io/v1/checks/10dlc/campaign

Runs the campaign, consent, message-content and website rules over a 10DLC messaging programme: use-case fit, sample messages, opt-in evidence, the STOP/HELP replies, and the privacy and terms pages the consent language points at. Pass the brand too — a campaign is filed against a brand and several rules compare the two, so a campaign checked without one comes back with those rules unresolved rather than passed.

Checks are free and unlimited and never consume allowance. Pass the subject as a stored-resource reference OR as an inline payload — never both for the same subject. With options.wait: true the connection is held until the verdict is ready; otherwise a fast check arrives already passed/changes_required and a slow one arrives processing for polling. options.include_website_review triggers a real crawl and is subject to a per-account daily quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The campaign, plus the brand it is filed against. Each subject is a stored reference OR an inline payload, never both. The brand is optional but strongly recommended: the rules that compare a campaign's content against its brand's identity cannot resolve without it, and report as unresolved rather than passed.

campaign_id

string

campaign

object

Inline campaign payload for checks and registrations. brand_id is omitted when paired with an inline brand. Partial payloads are welcome — missing or non-compliant fields surface as findings, not validation errors.

brand_id

string

brand

object

Inline brand payload for checks and registrations. Partial payloads are welcome — the marketed minimum is ein + website — and anything missing or non-compliant surfaces as findings, not validation errors.

options

object

Shared per-check switches.

metadata

object

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

Headers

Idempotency-Key

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.

Ekas-Subaccount

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Check created, with channel: 10dlc and subject_type: 10dlc_campaign. status is passed or changes_required when the check was fast or wait: true was set; processing otherwise — poll GET /checks/{id}.

400Invalid request (malformed body, missing/invalid parameter).

401Missing or invalid API key.

403API key lacks a required scope (named in error.param) or test-only endpoint called with a live key.

409Invalid state transition, in-flight registration conflict, or idempotency key reuse with a different body.

429Rate limit exceeded; see Retry-After. RateLimit-* headers appear on every response, not only 429s.