Create a new client

Request

Header Params

Authorization

string

required

Example:

Bearer {{access_token}}

Content-Type

string

required

Example:

application/json

Body Params application/json

name

string

required

email

string

required

metadata

object

required

Example

{
    "name": "string",
    "email": "string",
    "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/customers/v1/clients' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "string",
    "metadata": {}
}'

Responses

🟢200Success

application/json

Body

id

string <uuid>

required

The unique identifier of the client.

name

string

required

The name of the client.

email

string <email>

required

The email address of the client.

status

enum<string>

required

The current status of the client.

Allowed values:

INACTIVEACTIVE

created_at

string <date-time>

required

The date and time the client was created.

updated_at

string <date-time>

required

The date and time the client was last updated.

metadata

object

required

Metadata specific to the client.

Example

{
    "id": "0c98d6cd-37db-4155-b1bf-c77af7090e85",
    "name": "Tommie Wisoky",
    "email": "Ahmed.Cole@yahoo.com",
    "status": "ACTIVE",
    "created_at": "2025-01-14T16:31:56.262Z",
    "updated_at": "2025-01-14T16:31:56.263Z",
    "metadata": {}
}