staqlydocs
REST APIAPI referenceCollections

Update

Update (rename, describe, colour, processing timeout, archive)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

PATCH
/v1/collections/{id}

Archiving the Default collection (is_default) answers 409.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Request Body

application/json
  1. body
name?string
description?string
icon?string
color?string
processing_timeout_seconds?|

How long targets on your own automation may wait for a result before they fail; null goes back to the server's PROCESSING_TIMEOUT.

Range60 <= value <= 86400
archived?boolean

Response Body

OK

application/json
  1. response
id*string
name*string
description*string
icon*string
color*string
processing_timeout_seconds*|

How long a target on your own automation may wait for a result before it fails, in seconds (60 to 86400); null = the server's PROCESSING_TIMEOUT (see defaults.processing_timeout_seconds on GET /session).

is_default*boolean

The workspace's Default collection. Every workspace has exactly one; it can be renamed but not archived or deleted (409).

archived*boolean
archived_at*string|null
created_at*string
updated_at*string
post_count*integer
status_counts*

Posts by status

curl -X PATCH 'https://staqly.example.com/v1/collections/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "description": "string",  "icon": "string",  "color": "string",  "processing_timeout_seconds": 0,  "is_default": true,  "archived": true,  "archived_at": "string",  "created_at": "string",  "updated_at": "string",  "post_count": 0,  "status_counts": {    "property1": 0,    "property2": 0  }}