Update Exchange Context metadata (PATCH)

patch

https://staging.ankatech.co/api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

uuid

required

contextId

uuid

required

Body Params

PATCH-style update. Immutable surface: name, direction (set only at creation), applicationId, tenantId. Status changes use dedicated suspend / resume / close endpoints to keep the state machine auditable.

displayName

string

length between 0 and 255

description

string

counterparty

string

length between 0 and 255

businessPurpose

string

sensitivity

string

enum

Allowed:

counterpartyTypeId

object

Counterparty type id (FK to the catalog). Tri-state: omit = unchanged, null = clear, UUID = set. Cross-tenant references return 403.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

application/problem+json

200Exchange Context updated

400Validation failure on payload

403Tenant boundary violation or missing scope

404Exchange Context not found in tenant