v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequences

Pause a sequence

<small>Requires the sequences:operate scope (or a broader one that includes it).</small>

Pauses an active sequence. Returns the updated sequence.

This operation is idempotent: calling Pause on an already paused sequence returns 200 with the current sequence state. No error is raised.

post/v3/sequences/{id}/pause

Path parameters

idinteger required

Sequence Id

Response

Sequence is now paused. Returned both when the sequence was just paused and when it was already paused (idempotent).

idinteger

Unique identifier for the sequence

ownerUserIdinteger

Identifier of the user who owns the sequence

namestring

Name of the sequence

createdstring date-time

Sequence creation timestamp with timezone offset

status'new' | 'active' | 'paused'

Current status of the sequence

isArchivedboolean

Indicates if the sequence is archived

health'healthy' | 'stalled' | 'degraded' | 'blocked'

Overall health status of the sequence. Indicates whether the sequence can operate normally or has issues that need attention.

healthy — Sequence is functioning normally with no issues
stalled — Sequence has stalled and is not progressing
degraded — Sequence is running but with reduced effectiveness
blocked — Sequence cannot proceed due to critical issues

scheduleIdinteger

Schedule ID

Example response

{
  "id": 123,
  "ownerUserId": 42,
  "name": "Sales Outreach 2024",
  "status": "active",
  "created": "2024-03-08T14:30:00+00:00",
  "isArchived": false,
  "health": "degraded",
  "scheduleId": 1,
  "emailAccounts": [
    {
      "id": 1,
      "email": "sales@company.com"
    },
    {
      "id": 2,
      "email": "outreach@company.com"
    }
  ],
  "linkedInAccounts": [
    {
      "id": 42,
      "name": "John Doe",
      "profileUrl": "https://www.linkedin.com/in/johndoe",
      "status": "enabled"
    }
  ],
  "settings": {
    "emailsCountPerDay": 50,
    "daysToFinishProspect": 14,
    "emailSendingDelaySeconds": 30,
    "dailyThrottling": 200,
    "disableOpensTracking": false,
    "repliesHandlingType": "markAsFinished",
    "enableLinksTracking": true
  },
  "steps": [
    {
      "id": 1323,
      "type": "email",
      "delayInMinutes": 0,
      "executionMode": "automatic",
      "variants": [
        {
          "id": 1,
          "subject": "Quick question about {{companyName}}",
          "message": "<p>Hi {{firstName}},</p><p>I noticed you are leading initiatives at {{companyName}} and wanted to reach out.</p><p>Best regards, John</p>"
        }
      ]
    },
    {
      "id": 43432,
      "type": "linkedIn",
      "actionType": "message",
      "delayInMinutes": 2880,
      "executionMode": "automatic",
      "variants": [
        {
          "id": 2,
          "message": "Hi {{firstName}}, I noticed your great work at {{companyName}}. Would love to connect!",
          "isEnabled": true
        }
      ]
    }
  ]
}