Skip to main content
POST
/
v1
/
programs
/
{programId}
/
automations
/
{automationId}
/
refresh-subscriptions
Refresh subscriptions
curl --request POST \
  --url https://api.scrip.dev/v1/programs/{programId}/automations/{automationId}/refresh-subscriptions \
  --header 'X-API-Key: <api-key>'
{}
Re-evaluates a participant_state automation’s filter criteria against the current participant set. New participants that now match the filter are subscribed and will receive future triggers. Participants that no longer match have their subscriptions cancelled. Scrip runs this evaluation periodically on its own, but you can call this endpoint when you need the results immediately, for example after a bulk import or a rule change that affects participant state.
This endpoint only supports participant_state automations. Calling it on a cron, one_time, or immediate automation returns a 400 error. To manually fire those automation types, use the trigger endpoint instead.
For usage patterns and examples, see the Automations guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

programId
string<uuid>
required

Program ID

automationId
string<uuid>
required

Automation ID

Response

Evaluation queued

{key}
string