ShyniAPI
Availability

Change an availability block

PATCH
/api/v1/availability/blocks/{id}

Changes the dates, the kind, the reason or the times of a block; a field you leave out keeps its value and an empty reason, startTime or endTime clears it (an empty time = that edge day is closed whole). Only this occurrence changes; a block of a weekly series keeps its seriesId and its siblings stay as they are. The worker of a block cannot change - delete it and create a new one. The result must pass the same checks as a new block. An unknown or foreign id is 404. Requires the availability:write scope and an Idempotency-Key header.

Authorization

ApiKeyAuth availability:write
headerAuthorizationBearer <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

Path Parameters

id*string

Header Parameters

Idempotency-Key*string

Caller-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.

Lengthlength <= 64

Request Body

application/json
  1. body
startDate?string
Formatdate
endDate?string
Formatdate
kind?string
Value in"BUSY""VACATION"
reason?|

Empty string clears the reason.

Lengthlength <= 200
startTime?string

HH:mm local studio time. Omitted keeps it; an empty string clears it (startDate closed whole).

endTime?string

HH:mm local studio time. Omitted keeps it; an empty string clears it (endDate closed whole).

Response Body

The block.

application/json
  1. response
id*string
workerId*|

Null = the whole studio is closed.

startDate*string
Formatdate
endDate*string

Inclusive.

Formatdate
kind*string
Value in"BUSY""VACATION"
type*string

MANUAL for a block made by the studio or through this API.

Value in"MANUAL""EXTERNAL_SYNC"
reason*string|null
startTime*|

HH:mm local studio time the closure begins on startDate. Null = startDate is closed whole.

Match^([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.

Match^([01][0-9]|2[0-3]):[0-5][0-9]$
seriesId*|

Shared by the occurrences of a weekly repeat; null = a single block.

Example Request
curl -X PATCH 'https://api.shyni.io/api/v1/availability/blocks/string' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \  -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \  -H 'Content-Type: application/json' \  -d '{}'

Response 200

The 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."}

Create an availability block POST

Previous Page

Delete an availability block DELETE

Next Page