Create a client

Creates a new client object. Any parameters not provided will be left unset. This endpoint returns the created client object if the call succeeded.

Endpoint

POSThttps://api.saunaspa.rw/v1/clients

data_objectBody Parameters

emailstring

Required

The client's email address. Must be a valid email format and unique across all clients in your organization.

namestring

Optional

The client's full name or branch name.

phonestring

Optional

The client's phone number. Useful for SMS notifications regarding bookings.

metadataobject

Optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

infoUp to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

REQUEST

curl https://api.saunaspa.rw/v1/clients \

-u sk_test_123456789: \

-d email="jane.doe@example.com" \

-d name="Jane Doe" \

-d phone="+250788123456"

RESPONSE

200 OK

{
  "id": "cli_9f8g7h6i5j4k3l2m",
  "object": "client",
  "email": "jane.doe@example.com",
  "name": "Jane Doe",
  "phone": "+250788123456",
  "created_at": 1678886400,
  "metadata": {},
  "total_bookings": 0,
  "status": "active"
}