Update enduser

PATCH

/customers/v1/endusers/{id}

Update mutable fields of an existing enduser. Only the provided fields will be updated. Supports updating person details (first_name, last_name, phone_number, birthday), company details (name), and metadata.

Requires the client/write or administrator/write OAuth scope. Partial update: omitted fields are unchanged. person.email can also be updated (subject to the per-client uniqueness check). metadata is SHALLOW-merged — top-level keys you send are added/overwritten, other top-level keys are kept, but a nested object you send replaces the previous nested object entirely.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "person": {
        "first_name": "Jane",
        "phone_number": "+61400000000"
    },
    "metadata": {
        "tier": "premium"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/customers/v1/endusers/' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data '{
    "person": {
        "first_name": "Jane",
        "phone_number": "+61400000000"
    },
    "metadata": {
        "tier": "premium"
    }
}'

Responses

🟢200OK

application/json

Updated enduser

Bodyapplication/json

Example

{
    "id": "07777ee5-491f-46cd-bc66-0bb5c02fcb7e",
    "person": {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane@example.com",
        "birthday": "1990-01-15",
        "phone_number": "+61400000000"
    },
    "company": null,
    "metadata": {
        "tier": "premium"
    },
    "external_id": "ext-123"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-08-05 04:06:11

Get enduser by ID

Transactions API