Update a campaign

patch

https://app.ekas.io/v1/campaigns/{id}

Partial update. After approval, changed fields propagate to TCR and may trigger DCA re-review (documented per field). Returns 409 while a registration referencing this campaign is in flight (validating through submitted).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Partial update. Post-approval, changed fields propagate to TCR and may trigger DCA re-review (documented per field). 409 while a registration is in flight.

use_case

string

enum

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

description

string

sample_messages

array of strings

length between 1 and 5

sample_messages

message_flow

string

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.

privacy_policy_url

uri

terms_url

uri

reseller_id

string | null

auto_renewal

boolean

metadata

object

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

Headers

If-Match

string

ETag from a previous read; the write fails with 412 if the resource changed.

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200The updated campaign.

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.

404No such resource (or it belongs to another mode/subaccount).

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

412If-Match ETag no longer matches the resource.

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