Messaging

Pause a sequence

Nobody is dropped: a paused sequence advances nobody, and resuming carries each partner on from the step they were on.

Scope: write

post/v1/sequences/{id}/pause

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/sequences/{id}/pause
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

program_idstring required

Response

The paused sequence

idstring required

Prefixed id (seq_…)

object'sequence' required
program_idstring required

Prefixed id (prg_…)

namestring required
status'active' | 'paused' required
trigger'approved' | 'idle' | 'first_commission' required
trigger_daysinteger nullable required
stepsinteger required
created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "seq_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.