Create a new enduser

POST

/customers/v1/endusers

Create a new enduser to with person or company entity and metadata.

Not idempotent. This endpoint does not honour Idempotency-Key. Sending the header is not an error and has no effect: the request executes every time, and a retry creates a second record. Deduplication is the caller's responsibility.

Request

Header Params

Body Params application/json

Example

{
    "person": {
        "first_name": "Sam",
        "last_name": "Jhon",
        "email": "abn@bbc.com",
        "birthday": "1970-01-01",
        "phone_number": "+61412345678"
    },
    "metadata": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/customers/v1/endusers' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "person": {
        "first_name": "Sam",
        "last_name": "Jhon",
        "email": "abn@bbc.com",
        "birthday": "1970-01-01",
        "phone_number": "+61412345678"
    },
    "metadata": {}
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "id": "07777ee5-491f-46cd-bc66-0bb5c02fcb7e",
    "company": {
        "name": "sam"
    },
    "metadata": {}
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-09-15 01:24:19

Get all endusers

Get enduser by ID