curl --request POST \
--url 'https://api.workstream.stateset.com/v1/workflows/subscription-retention/trigger' \
--header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer_email": "ada.lovelace@example.com",
"cancel_reason": "string"
}'
{
"workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Trigger retention workflow
Success
POST
/
v1
/
workflows
/
subscription-retention
/
trigger
curl --request POST \
--url 'https://api.workstream.stateset.com/v1/workflows/subscription-retention/trigger' \
--header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer_email": "ada.lovelace@example.com",
"cancel_reason": "string"
}'
{
"workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Request body
RetentionTriggerInput
string (uuid)
string (uuid)
required
string
required
string
string
Response
StartWorkflowResponse
string
required
string
Status codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Validation error |
401 | Unauthorized |
404 | Not found |
429 | Rate limited |
500 | Internal error |
curl --request POST \
--url 'https://api.workstream.stateset.com/v1/workflows/subscription-retention/trigger' \
--header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer_email": "ada.lovelace@example.com",
"cancel_reason": "string"
}'
{
"workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Last modified on August 31, 2026