ArgorantDocs

Turn a follow-up sequence off or on

patchhttps://app.argorant.com/api/v1/campaigns/{campaign_id}/subsequences/{subsequence_id}
PATCH
/api/v1/campaigns/{campaign_id}/subsequences/{subsequence_id}

false turns it off, true turns it on again.

Only when turning it off. `finish` lets the people already in it get the rest of its emails, `stop` ends them now.

Turns one follow-up sequence off or back on. Off means no new reply starts it. Its keywords and emails stay saved. When you turn it off, existing_leads says what happens to the people already in it. finish (the default) lets them get the rest of its emails. stop ends their emails from it now. Stopped people are not counted as finished. enabled: true turns it on again, and replies with its keywords start it again. The answer holds every sequence of the campaign and change with how many people were stopped.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists

Authorization

BearerAuth
AuthorizationBearer <token>

Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.

In: header

Path Parameters

campaign_id*string

The campaign id from create or list.

Formatuuid
subsequence_id*string

The sequence id from GET /api/v1/campaigns/{campaign_id}/subsequences.

Formatuuid

Header Parameters

Idempotency-Key?string

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

Lengthlength <= 128
X-Request-Id?string

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Match^[A-Za-z0-9._-]{8,64}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Shell
curl -X PATCH "https://app.argorant.com/api/v1/campaigns/7f3a2c1e-9b4d-4e8a-a1c2-5d6e7f8a9b0c/subsequences/5e4d3c2b-1a09-4f8e-9d7c-6b5a4f3e2d1c" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "enabled": false,    "existing_leads": "finish"  }'
JSON
{  "subsequences": [    {      "id": "5e4d3c2b-1a09-4f8e-9d7c-6b5a4f3e2d1c",      "name": "Asked about pricing",      "keywords": [        "pricing",        "cost"      ],      "enabled": false,      "off_mode": "finish",      "disabled_at": "2026-10-22T09:00:00+00:00",      "stats": {        "people": 14,        "in_progress": 3,        "replied": 2,        "finished": 9,        "stopped": 0,        "emails_sent": 31      }    }  ],  "change": {    "subsequence_id": "5e4d3c2b-1a09-4f8e-9d7c-6b5a4f3e2d1c",    "enabled": false,    "existing_leads": "finish",    "stopped": 0,    "in_progress_left": 3  }}