FIfireblocks
Compliance

Update a counterparty group

Updates an existing counterparty group.

Endpoint Permissions: Admin, Non-Signing Admin.

patch/counterparty_groups/{groupId}

Request

Path parameters

groupIdstring uuid required

The unique identifier of the counterparty group

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

namestring

Updated human-readable name of the group

descriptionstring

Updated description of the group

jurisdictionCodesstring[]

Updated list of jurisdiction codes for the group

isActiveboolean

Whether the counterparty group should be active

Example request

{
  "name": "APAC Financial Partners",
  "description": "Group for all APAC-based financial institution counterparties",
  "jurisdictionCodes": [
    "US",
    "SG"
  ],
  "isActive": true
}

Response

Counterparty group updated successfully

groupIdstring uuid required

Unique identifier of the counterparty group

namestring required

Human-readable name of the group

descriptionstring

Optional description of the group

jurisdictionCodesstring[]

List of jurisdiction codes associated with the group

isActiveboolean required

Whether the counterparty group is currently active

createdAtstring date-time required

ISO 8601 timestamp when the group was created

updatedAtstring date-time required

ISO 8601 timestamp when the group was last updated

Example response

{
  "groupId": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "name": "APAC Financial Partners",
  "description": "Group for all APAC-based financial institution counterparties",
  "jurisdictionCodes": [
    "US",
    "SG"
  ],
  "isActive": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.