Queues
Update a queue
Rename a queue, pause or resume it, or change its flush rules. Only the fields sent change.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
workflows_app_queue_id*stringThe queue.
uuidregion*RegionsRegion of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them
"besg""usnv"application/json- body
queue_name?|nullstatus?|nullflush_batch_size?|nullflush_record_max_age?|nullflush_rate_limit_max_flush_count?|nullflush_rate_limit_time_window?|nullflush_strategy?|nullvalidate_only?Validate OnlyRun every check of the write and answer 204 without writing: a refused write answers the error the write would
falseOK
application/json- response
queue_id*Queue Idqueue_name*Queue Namequeue_resource_id*Queue Resource Idstatus*QueueStatus"running""paused"consumer_workflow_id*|The workflow that receives the flushed records, if any
flush_batch_size*Flush Batch SizeRecords sent to the consumer workflow per flush
flush_record_max_age*|Seconds a record may wait before the queue flushes
flush_rate_limit_max_flush_count*|Maximum flushes per rate limit window
flush_rate_limit_time_window*|The rate limit window, in seconds
flush_strategy*AppQueueFlushStrategyfifo sends the oldest records first, lifo the newest
"fifo""lifo"parent_folder_id*string|nullcreated_time*Created Timedate-timelast_modified_time*Last Modified Timedate-timeregion*Regions"besg""usnv"curl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/queues/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "queue_name": "<queue_name>"}'{ "queue_id": "<queue_id>", "queue_name": "<queue_name>", "queue_resource_id": "<queue_resource_id>", "status": "running", "consumer_workflow_id": "<consumer_workflow_id>", "flush_batch_size": 0, "flush_record_max_age": 0, "flush_rate_limit_max_flush_count": 0, "flush_rate_limit_time_window": 0, "flush_strategy": "fifo", "parent_folder_id": "<parent_folder_id>", "created_time": "2027-01-15T09:00:00Z", "last_modified_time": "2027-01-15T09:00:00Z", "region": "besg"}POSTCreate a queue
A queue, running unless sent paused: records added by workflows (and syncs) wait in it until its flush rules send them to its consumer workflow. Send the status, rate limit and strategy of a queue read with GET to copy it. Send an Idempotency-Key to retry safely.
DELDelete a queue
Its waiting records are removed; workflows using it can no longer add or receive records.