SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
appointments

Create a customer. Matching on email then phone avoids duplicates.

Create a customer. Matching on email then phone avoids duplicates.

POSThttps://app.softsolz.uk/api/v1/services/appointments/customers

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

display_namestring

Name shown throughout the product.

emailstring

Email address.

phonestring

Phone number in international format.

timezonestring

IANA timezone, for example Europe/London.

localestring

Preferred language tag, for example en-GB.

addressesarray of objects

Saved addresses.

tagsarray of strings

Free-form labels for grouping and filtering.

notesstring

Free-text notes.

custom_fieldsobject

Your own extra fields, keyed by the definitions in workspace settings.

external_refstring

Your own identifier for this person.

messaging_consentboolean

Whether this person accepts SMS, WhatsApp, and calls.

marketing_consentboolean

Whether this person accepts marketing messages.

Response

Response Body

idintegerUnique identifier.
display_namestringName shown throughout the product.
emailstring | nullEmail address.
phonestring | nullPhone number in international format.
timezonestring | nullIANA timezone, for example Europe/London.
addressesarray of objectsSaved addresses.
tagsarray of stringsFree-form labels for grouping and filtering.
custom_fieldsobjectYour own extra fields, keyed by the definitions in workspace settings.
no_show_countintegerHow many appointments this person did not attend.
completed_countintegerHow many appointments this person attended.
created_atstringWhen the record was created.
updated_atstringWhen the record was last changed. Round-trip as expected_updated_at to guard against stale writes.

Request

import { SoftSolz } from '@softsolz/sdk';


const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });


const result = await client.appointments.createCustomer({});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
  "data": {
    "id": 0,
    "display_name": "string",
    "email": "string",
    "phone": "string",
    "timezone": "string",
    "addresses": [],
    "tags": [],
    "custom_fields": {},
    "no_show_count": 0,
    "completed_count": 0,
    "created_at": "string",
    "updated_at": "string"
  }
}