Skip to main content
POST
Update Pool
Send only what changes: daily_limits, publish_settings and target_weights merge key by key, hosts and targets replace the lists when present. The same checks as on creation apply to the merged result. The status is not touched here; use POST /shoutouts/pools/{uuid}/status to pause, resume or archive. An archived pool answers 422 pool_not_editable.

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

Only the fields sent change. daily_limits, publish_settings and target_weights merge key by key; hosts and targets replace the lists.

name
string
Maximum string length: 100
formats
enum<string>[]
Available options:
story,
post,
bio,
friends,
mass_dm
start_date
string<date>
end_date
string<date> | null
rotation_type
enum<string>
Available options:
equal,
priority,
weighted
daily_limits
object
same_target_cooldown_days
integer
Required range: 1 <= x <= 90
friends_ttl_days
enum<integer>
Available options:
3,
5,
7,
14,
30
bio_ttl_days
enum<integer>
Available options:
3,
5,
7,
14,
30
post_ttl_days
enum<integer>
Available options:
1,
3,
5,
7
publish_settings
object

How publications go out.

hosts
integer[]
targets
integer[]
target_weights
object

Response

Successful response

success
boolean
Example:

true

data
object