Create a customer

POST

https://api-dev.skiplino.com/external/v1/customers/create

Creates a customer record in your company's directory. Every field is optional, but
supplying an externalId is strongly recommended — it maps the Skiplino customer to
your own system's identifier and makes creation safely retryable (uniqueness enforced
per company).

Authentication — Secret key only (sk_…). A public key returns 401.

Behavioural notes

The server generates the internal _id (a 32-character hexadecimal string) and the
createdAt/updatedAt timestamps.

Empty/omitted optional fields are simply not stored.

A duplicate externalId for the same company returns 422 (

This value is already
taken.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Customer created successfully.

Bodyapplication/json

🟠422

🟠401Unauthorized

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

cURL

Minimal — empty bodyTypical — external id + contactFull — with metadata

curl --location 'https://api-dev.skiplino.com/external/v1/customers/create' \
--header 'X-Locale;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'

Response Example

201 - Success

{
    "message": "Customer created successfully.",
    "data": {
        "_id": "9f2c8b7a4e1d6c3f0a5b8e2d7c4f1a9b",
        "externalId": "crm-7741",
        "companyId": "cmp_5f3a91",
        "name": "Layla Hassan",
        "email": "layla.hassan@example.com",
        "mobile": "+97333445566",
        "metadata": {
            "tier": "gold",
            "source": "mobile-app"
        },
        "createdAt": "2026-06-23T11:00:00.000Z",
        "updatedAt": "2026-06-23T11:00:00.000Z"
    }
}

Reschedule an appointment

List customers (paginated)