Skip to main content
POST
Pool Status
paused stops new publications while the live ones stay up; active resumes a paused or completed pool; archived is final and hides the pool from the list of active ones. Other moves answer 422 status_transition_invalid.

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

uuid
string<uuid>
required

Pool id: the pool_id value from the pools list.

Body

application/json
status
enum<string>
required

active resumes a paused or completed pool; archived is final.

Available options:
active,
paused,
archived

Response

Successful response

success
boolean
Example:

true

data
object