Create a new client

POST

/customers/v1/clients

Create a client. Kobble-performed operation. This endpoint requires the administrator/write scope, which is reserved for Kobble-internal credentials and is not granted to client API credentials — requesting it at the token endpoint will be rejected.

Request

Header Params

Body Params application/json

Example

{
    "name": "Acme Pty Ltd",
    "email": "ops@acme.example",
    "metadata": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/customers/v1/clients' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Pty Ltd",
    "email": "ops@acme.example",
    "metadata": {}
}'

Responses

🟢201Created

application/json

Client created. New clients are ALWAYS created with status INACTIVE; activation is an operational step performed by Kobble (there is no self-serve activation call).

Bodyapplication/json

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

Get client by ID

Update client status