Update stakeholder

PATCH

/customers/v1/endusers/{id}/stakeholders/{stakeholderId}

Update mutable fields of a stakeholder. Partial update: omitted fields are unchanged; address and roles are replaced as a whole when provided. Set status to INACTIVE to soft-delete the stakeholder (there is no DELETE endpoint). Owner-scoped through the parent enduser. Requires the client/write or administrator/write OAuth scope.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "status": "INACTIVE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/customers/v1/endusers//stakeholders/' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data '{
    "status": "INACTIVE"
}'

Responses

🟢200OK

application/json

Updated stakeholder.

Bodyapplication/json

Example

{
    "id": "3f0a2b1c-9d4e-4f6a-8b7c-1d2e3f4a5b6c",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "phone_number": "+61412345678",
    "birthday": "1980-05-20",
    "address_line1": "1 Collins St",
    "address_line2": null,
    "address_city": "Melbourne",
    "address_state": "VIC",
    "address_postal_code": "3000",
    "address_country": "AUS",
    "gender": null,
    "nationality": null,
    "country_of_birth": null,
    "id_document_type": null,
    "id_document_number": null,
    "id_document_expiry": null,
    "id_document_country": null,
    "occupation_code": null,
    "roles": [
        "DIRECTOR",
        "UBO"
    ],
    "ownership_percent": "40",
    "title": "Director",
    "status": "INACTIVE"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-09-24 11:55:30

List stakeholders

Transactions API