DKBSignDocs

API reference

PUTRequires Bearer token

Update availability

/api/v1/profile/{user}/availability

Mark yourself unavailable and optionally designate 0–2 active colleagues as interims (same company, not self). Webhooks fire only when effective availability changes.

Path parameters

FieldTypeDescription
user
Required
stringPath parameter user.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
is_available
Required
booleanWhether the user is available.
e.g. false
unavailable_until
stringOptional end date Y-m-d, or null.
e.g. "2026-10-15"
interim_user_ids
Required
array0–2 distinct colleague ids. May be empty.
e.g. [8,9]

Responses

StatusMeaning
200Availability updated
401Missing or invalid Bearer token.

Request

curl
curl -X PUT 'https://api.dkbsigns.com/api/v1/profile/user/availability' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"is_available":false,"interim_user_ids":[8,9],"unavailable_until":"2026-10-15"}'

Response 200

json
{
  "status": "success",
  "message": "Availability updated",
  "data": {
    "is_available": false
  }
}