Create an availability block
Closes the studio (no workerId) or one worker for startDate..endDate, both inclusive. kind is
BUSY or VACATION. A block is live at once: the removed starts disappear from
GET /availability/starts. startDate cannot be in the past and a block spans at most 365 days.
startTime / endTime (HH:mm, local studio time) close only part of the edge days: startTime is when
the closure begins on startDate, endTime when it ends on endDate; a missing one means that edge day is
closed whole. Those days are then partially closed (not in closedDays), the starts inside the window
disappear from GET /availability/starts, and work that would run into the window pauses and resumes after
it. On a single-day block endTime must be after startTime. A VACATION is whole days only (times are
rejected).
repeat.weeklyUntil repeats the block every 7 days while an occurrence starts on or before that date (at most
365 days after startDate; the block must span fewer than 7 days). Each occurrence is its own block sharing
one seriesId; the response is the first one, and GET /availability/blocks lists the rest. Delete one
occurrence with DELETE /availability/blocks/{id}, the remaining ones with
DELETE /availability/block-series/{seriesId} (occurrences that already ended are kept).
An unknown workerId is 404 with field: workerId. Same rules as the admin. Requires the
availability:write scope and an Idempotency-Key header; no particular plan.
ApiKeyAuth availability:writeAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: availability:write
Idempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64application/json- body
workerId?|Omitted = the whole studio.
startDate*stringdateendDate*stringdatekind*string"BUSY""VACATION"reason?|length <= 200startTime?|HH:mm local studio time the closure begins on startDate. Omitted = startDate is closed whole. Not for VACATION.
^([01][0-9]|2[0-3]):[0-5][0-9]$endTime?|HH:mm local studio time the closure ends on endDate. Omitted = endDate is closed whole. Not for VACATION.
^([01][0-9]|2[0-3]):[0-5][0-9]$repeat?Repeat the block weekly.
The new block.
application/json- response
id*stringworkerId*|Null = the whole studio is closed.
startDate*stringdateendDate*stringInclusive.
datekind*string"BUSY""VACATION"type*stringMANUAL for a block made by the studio or through this API.
"MANUAL""EXTERNAL_SYNC"reason*string|nullstartTime*|HH:mm local studio time the closure begins on startDate. Null = startDate is closed whole.
^([01][0-9]|2[0-3]):[0-5][0-9]$endTime*|HH:mm local studio time the closure ends on endDate. Null = endDate is closed whole.
^([01][0-9]|2[0-3]):[0-5][0-9]$seriesId*|Shared by the occurrences of a weekly repeat; null = a single block.
curl -X POST 'https://api.shyni.io/api/v1/availability/blocks' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "startDate": "2019-08-24", "endDate": "2019-08-24", "kind": "BUSY"}'Response 201
The new block.
{ "id": "string", "workerId": "string", "startDate": "2019-08-24", "endDate": "2019-08-24", "kind": "BUSY", "type": "MANUAL", "reason": "string", "startTime": "string", "endTime": "string", "seriesId": "string"}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 409
The request is well-formed but the studio's current state forbids it.
{ "code": "CONFLICT", "message": "The voucher cannot be deactivated because it is not active."}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}