SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
appointments

Create an asset.

Create an asset.

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

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

Your own category, for example vehicle, property, machine, or animal.

customer_idinteger

Customer this belongs to.

parent_asset_idinteger

Parent asset, so a building can contain rooms.

identifierstring

Registration, serial, or reference.

addressobject

Street address and optional coordinates.

custom_fieldsobject

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

is_activeboolean

Whether this record is in use.

Response

Response Body

idintegerUnique identifier.
customer_idinteger | nullCustomer this belongs to.
parent_asset_idinteger | nullParent asset, so a building can contain rooms.
kindstringYour own word for the thing a visit is about, for example vehicle or property.
namestringDisplay name.
identifierstring | nullRegistration, serial, or reference.
addressobject | nullStreet address and optional coordinates.
custom_fieldsobjectYour own extra fields, keyed by the definitions in workspace settings.
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.createAsset({});
console.log(result);

Credentials

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

Response · 201

{
"data": {
"id": 0,
"customer_id": 0,
"parent_asset_id": 0,
"kind": "string",
"name": "string",
"identifier": "string",
"address": "string",
"custom_fields": {},
"is_active": true,
"created_at": "string",
"updated_at": "string"
}
}