Update an arrangement

Updates an arrangement’s mutable fields. Omitted fields are left unchanged. A duplicate (participant, code, role) returns 409; an invalid role/code 422. RBAC: arrangements:write.

PUT /v1/participants/{id}/arrangements/{arrangementId}

Update an arrangement

cURL

curl --request PUT \
  --url https://slc.sandbox.lerian.net/v1/participants/{id}/arrangements/{arrangementId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "code": "<string>",
  "role": "<string>"
}
'

200

{
  "active": true,
  "code": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "participantId": "<string>",
  "role": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Owning participant id (UUID).

Example:

"0190b5a0-0000-7000-8000-0000000000aa"

arrangementId · string · required

Arrangement id (UUID).

Example:

"0190b5a0-0000-7000-8000-0000000000bb"

Body

application/json

active · boolean | null

Whether the arrangement is active. Nil leaves it unchanged.

Example:

true

code · string

Card-scheme arrangement code. Omitted leaves it unchanged.

Example:

"VCC"

role · string

Participant role for this arrangement. Omitted leaves it unchanged.

Example:

"ACQUIRER"

Response

200

application/json

OK

active · boolean · required

Whether the arrangement is active.

Example:

true

code · string · required

Card-scheme arrangement code.

Example:

"VCC"

createdAt · string<date-time> · required

Creation timestamp (RFC3339 UTC).

Example:

"2026-06-15T07:50:00Z"

id · string · required

Arrangement id (UUID).

Example:

"0190b5a0-0000-7000-8000-0000000000bb"

participantId · string · required

Owning participant id (UUID).

Example:

"0190b5a0-0000-7000-8000-0000000000aa"

role · string · required

Participant role for this arrangement.

Example:

"ACQUIRER"

updatedAt · string<date-time> · required

Last-update timestamp (RFC3339 UTC).

Example:

"2026-06-15T07:50:00Z"