Start return lifecycle workflow

Workflow started (or the existing run returned when the deterministic workflow id already exists).

POST /v1/workflows/return-lifecycle/start

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/workflows/return-lifecycle/start' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connector_key_mail": "string",
  "connector_key_sms": "string",
  "connector_key_returns": "string",
  "connector_key_refund": "string",
  "refund_provider": "string",
  "customer_email": "[e-mail]",
  "customer_phone": "[phone]",
  "order_number": "ORD-10042",
  "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "refund_amount_minor": 4900,
  "currency": "USD",
  "return_items": null,
  "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "escalation_assignee": "string",
  "reminder_interval_secs": 1,
  "max_reminders": 1,
  "expiry_secs": 1,
  "customer_timezone": "America/Los_Angeles",
  "quiet_hours_start_hour": 1,
  "quiet_hours_end_hour": 1,
  "idempotency_key": "req_01J9X4Q8M2ZK7V3N",
  "copy": {
    "brand_name": "Acme Outdoors",
    "sender_signature": "string",
    "email_subject_override": "string"
  },
  "routing_mode": "string"
}'

200

{
  "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Request body

object

brand_id · string (uuid) · required

connector_key_mail · string · required

connector_key_sms · string

connector_key_returns · string

connector_key_refund · string

refund_provider · string

customer_email · string · required

customer_phone · string

order_number · string

order_id · string

charge_id · string

refund_amount_minor · integer

currency · string

return_items · object

Return line items (free-form JSON)

conversation_id · string

escalation_assignee · string

reminder_interval_secs · integer

max_reminders · integer

expiry_secs · integer

customer_timezone · string

quiet_hours_start_hour · integer

quiet_hours_end_hour · integer

idempotency_key · string

copy · object

routing_mode · string

Response

StartWorkflowResponse

workflow_id · string · required

run_id · string

Status codes

Code	Meaning
200	Workflow started (or the existing run returned when the deterministic workflow id already exists).
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/workflows/return-lifecycle/start' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connector_key_mail": "string",
  "connector_key_sms": "string",
  "connector_key_returns": "string",
  "connector_key_refund": "string",
  "refund_provider": "string",
  "customer_email": "[e-mail]",
  "customer_phone": "[phone]",
  "order_number": "ORD-10042",
  "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "refund_amount_minor": 4900,
  "currency": "USD",
  "return_items": null,
  "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "escalation_assignee": "string",
  "reminder_interval_secs": 1,
  "max_reminders": 1,
  "expiry_secs": 1,
  "customer_timezone": "America/Los_Angeles",
  "quiet_hours_start_hour": 1,
  "quiet_hours_end_hour": 1,
  "idempotency_key": "req_01J9X4Q8M2ZK7V3N",
  "copy": {
    "brand_name": "Acme Outdoors",
    "sender_signature": "string",
    "email_subject_override": "string"
  },
  "routing_mode": "string"
}'

200

{
  "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}