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.

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 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "person": {
        "first_name": "Jane",
        "phone_number": "+61400000000"
    },
    "metadata": {
        "tier": "premium"
    }
}'

Responses

🟢200OK

application/json

Updated enduser

Body

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"
    },
    "person_id": "b55d4ef2-7cc2-49c1-a718-f71d3ae9fef5",
    "company": null,
    "company_id": null,
    "metadata": {
        "tier": "premium"
    },
    "external_id": "ext-123"
}

🟠404Record Not Found

🟠429

Modified at 2026-04-08 06:16:10

Get enduser by ID

Transactions API