SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
appointments

Create a resource.

Create a resource.

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

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

namestring

Display name.

kindstring

staff, contractor, room, equipment, vehicle, team, or your own word such as chair or studio. Lower case letters, numbers, and underscores.

emailstring

Email address.

phonestring

Phone number in international format.

timezonestring

IANA timezone, for example Europe/London.

colorstring

Colour used on the calendar.

skillsarray of strings

Skills this resource holds, used for matching.

capacityinteger

Places available. 1 is one-to-one; above 1 enables group booking.

is_activeboolean

Whether this record is in use.

custom_fieldsobject

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

Response

Response Body

idintegerUnique identifier.
kindstringstaff, contractor, room, equipment, vehicle, team, or your own word such as chair or studio.
namestringDisplay name.
emailstring | nullEmail address.
phonestring | nullPhone number in international format.
timezonestring | nullIANA timezone, for example Europe/London.
skillsarray of stringsSkills this resource holds, used for matching.
capacityintegerPlaces available. 1 is one-to-one; above 1 enables group booking.
is_activebooleanWhether this record is in use.
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.createResource({});
console.log(result);

Credentials

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

Response · 201

{
  "data": {
    "id": 0,
    "kind": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "timezone": "string",
    "skills": [],
    "capacity": 0,
    "is_active": true,
    "created_at": "string",
    "updated_at": "string"
  }
}