SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
appointments

Update a follow-up task.

Update a follow-up task.

PATCHhttps://app.softsolz.uk/api/v1/services/appointments/tasks/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

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

titlestring

Short label shown on the calendar.

descriptionstring

Optional longer description.

assignee_user_idinteger

Workspace member responsible for this.

due_atstring

When this is due.

statusstring

Current status.

Response

Response Body

idstringTask id. Use it as the id in PATCH /tasks/{id}. A whole number sent as a string.
appointment_idstring | nullAppointment the task follows up. A whole number sent as a string, or null.
customer_idstring | nullCustomer the task is about. A whole number sent as a string, or null.
titlestringShort task title.
descriptionstring | nullLonger details.
assignee_user_idinteger | nullWorkspace member responsible for it.
due_atstring | nullWhen the task is due.
statusstringopen until it is done or cancelled.
completed_atstring | nullWhen it was marked done. Cleared when it is reopened.
created_atstringWhen the task was created.
updated_atstringWhen the task was last changed.
tenant_idstringThe workspace this record belongs to.
created_byinteger | nullWorkspace member who created it. Null for tasks created through the API.

Request

curl --request PATCH \
  --url https://app.softsolz.uk/api/v1/services/appointments/tasks/{id} \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "done"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "id": "11",
    "appointment_id": "650",
    "customer_id": "990",
    "title": "Call back about the quote",
    "description": "Confirm the part price",
    "assignee_user_id": 4121,
    "due_at": "2027-03-02T09:00:00.000Z",
    "status": "open",
    "completed_at": null,
    "created_at": "2026-10-01T17:42:56.512Z",
    "updated_at": "2026-10-01T17:42:56.512Z",
    "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61",
    "created_by": null
  }
}