Update an RCS agent

patch

https://app.ekas.io/v1/rcs-agents/{id}

Partial update. Returns 409 while a registration referencing this agent is in flight (validating through submitted).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Partial update; same in-flight registration rules as other subjects.

display_name

string

description

string

color

string

logo_file_id

string

hero_file_id

string

phone

object

website

object

privacy_policy_url

uri

terms_url

uri

use_case

string

enum

Allowed:

billing_category

string

enum

Carriers accept different categories; checks flag unsupported combinations.

Allowed:

verification_contact

object

opt_in

object

opt_out

object

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

help

object

triggers

string

interactions

string

sample_messages

array of strings

sample_messages

target_regions

array of strings

target_regions

target_carriers

array of strings

target_carriers

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 RCS agent.

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.