Create an Exchange Context under an Application

Creates a governed interaction scenario scoped to a specific Application. The Exchange Context starts in PENDING_ACTIVATION and can later be activated, suspended, resumed or closed via dedicated endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
uuid
required
Body Params
string
required
length between 0 and 255
^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$

Technical slug unique within the Application. Lowercase alphanumerics and hyphens only.

string
length between 0 and 255

Human-readable label

string

Free-text description of the exchange relationship

string
length between 0 and 255

Counterparty name (partner, vendor, regulator)

string
enum
required

Flow direction. Immutable once set (fresh context for a new direction).

Allowed:
string

Business purpose of the exchange (visible to auditors)

string
enum

Data classification of the exchanged payload

Allowed:
uuid

Optional FK to the counterparty type catalog. The id MUST belong to the same tenant as the Exchange Context, OR be a platform-global type (tenant_id IS NULL). 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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json