Update a counterparty

PATCH

/counterparties/{id}

Partially updates an existing counterparty belonging to the authenticated entity. Only the fields you include in the request body are modified; omitted fields retain their current values.

You can update name details, contact information, address, status, and arbitrary metadata. Email cannot be changed after creation.

If you provide a client_reference, it must be unique across all counterparties under the same entity (excluding the current counterparty). Changing status to inactive is the recommended way to soft-disable a counterparty without deleting it.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Counterparty updated successfully. Returns the full updated counterparty object.

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

Request Example

Shell

JavaScript

Java

Swift

cURL

Update name fieldsDeactivate counterpartyUpdate all editable fields

curl --location --request PATCH '/counterparties/01HZ9KPQR3VTXMN84JWYB65CD0' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "first_name": "Janet",
    "last_name": "Doe"
}'

Response Example

200 - Success

{
    "message": "Counterparty updated successfully",
    "status": "success",
    "data": {
        "id": "01HZ9KPQR3VTXMN84JWYB65CD0",
        "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
        "email": "jane.doe@example.com",
        "status": "inactive",
        "first_name": "Janet",
        "last_name": "Doe",
        "phonenumber": "+2348099887766",
        "client_reference": "cust-00412-v2",
        "created": 1722870000000,
        "updated": 1722873600000
    }
}

Modified at 2026-08-12 16:05:45

List counterparties

Retrieve a counterparty