Sequences
Start a sequence
<small>Requires the sequences:operate scope (or a broader one that includes it).</small>
Activates a new or paused sequence. Returns the updated sequence.
This operation is idempotent: calling Start on an already active sequence returns 200 with the current sequence state. No error is raised.
post/v3/sequences/{id}/start
Request
- Base URLhttps://api.reply.io
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idinteger required
Sequence Id
Response
Sequence is now active. Returned both when the sequence was just started and when it was already active (idempotent).
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
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.