LeadArc Docsv1

Markdown for agents

This page as plain markdown, ready to paste into an LLM.

.md

Sequences

Follow-up sequences and their steps.

sequences:readread bucketreturns list of sequence

Follow-up sequences with steps

bash
curl -sS https://api.leadarc.io/v1/workspaces/airpay/sequences?limit=25 \
  -H "Authorization: Bearer $LEADARC_API_KEY"

Query parameters. Anything else is 400 unsupported_filter.

active cursor expand limit order visibility

Errors from this endpoint, on top of the common ones: invalid_cursor, invalid_request.

json
{
  "object": "sequence",
  "id": "seq_xOvbSvBxb2iRNkVtF2TOMsc1oCMVYnVwFPMd09",
  "workspace": "airpay",
  "name": "Interested but went quiet",
  "active": true,
  "visibility": "workspace",
  "send_days": ["mon", "tue", "wed", "thu", "fri"],
  "send_days_mask": 62,
  "created_by_id": "usr_zaDRRpdu8EPZSU3i89lvZgKPkVQo4uBFA_KOhm",
  "created_at": "2026-06-20T10:00:00Z",
  "steps": [
    {
      "object": "sequence_step",
      "id": "stp_Fgz1ygOA3HvHnLXpEYhVbWkFxDWJ8g7K211AFt",
      "order_index": 0,
      "type": "email",
      "title": "Send the Loom",
      "delay_value": 0,
      "delay_unit": "days",
      "wait_for_previous": false,
      "template_id": "tpl_RkPo3VxECLfgHxyPBBBi5GTDYNiRwMWrLWUEo_",
      "email_body": null,
      "linkedin_text": null
    },
    {
      "object": "sequence_step",
      "id": "stp_Fgz1ygOA3HvHnLXpEYhVbWkFxDWJ8g7K211AFt",
      "order_index": 1,
      "type": "call",
      "title": "Ring the mobile",
      "delay_value": 2,
      "delay_unit": "days",
      "wait_for_previous": true,
      "template_id": null,
      "email_body": null,
      "linkedin_text": null
    }
  ]
}

send_days is the readable form of followup_sequences.send_days_mask, which is a 7-bit weekday mask where bit i is Date.getUTCDay() and 0 is Sunday. Default 127 is every day. Both forms are returned, and these pages state the UTC basis, because a sequence set to weekdays fires on UTC weekdays and not the rep's.

wait_for_previous maps to followup_sequence_steps.wait_for_prev.

followup_sequences.deleted_at is withheld. Soft-deleted sequences are filtered out.

sequences:writewrite bucket

Enroll one lead from a mobile session

bash
curl -sS https://api.leadarc.io/v1/workspaces/airpay/leads/lead_BP2vnPmKyttNP2OlH_mWL78t1o6nBVC6oVbHny/enrollments \
  -X POST \
  -H "Authorization: Bearer $LEADARC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sequence_id":"usr_zaDRRpdu8EPZSU3i89lvZgKPkVQo4uBFA_KOhm"}'

Body fields. An unknown field is rejected.

sequence_id

Errors from this endpoint, on top of the common ones: enrollment_exists, internal_error, invalid_request, not_found, sequence_inactive.

json
{ "sequence_id": "seq_xOvbSvBxb2iRNkVtF2TOMsc1oCMVYnVwFPMd09" }

The server derives the workspace, lead, representative reply, and enrolling user. It creates the enrollment and its first task batch in one transaction. A retry with the same key returns the stored response. A new key for the same lead and sequence is a no-op and returns tasks_created: [].

json
{
  "object": "enrollment",
  "id": "enr_CJVJgm01CZsYpN0Ob9shniKYFctfbKzCmFRdM9",
  "workspace": "airpay",
  "sequence_id": "seq_xOvbSvBxb2iRNkVtF2TOMsc1oCMVYnVwFPMd09",
  "lead_id": "lead_BP2vnPmKyttNP2OlH_mWL78t1o6nBVC6oVbHny.53d108",
  "reply_id": "rep_Dk9dw7dVABGNJm9HK9onvZKXLneRRpj9MIB-C3",
  "status": "active",
  "next_step_index": 1,
  "enrolled_by_id": "usr_zaDRRpdu8EPZSU3i89lvZgKPkVQo4uBFA_KOhm",
  "created_at": "2026-08-31T12:00:00.000Z",
  "effects": { "tasks_created": ["tsk_i-_uD-R7uXULK8lecjVGbgq71OpftiUkqXfdvx.0d1944"] }
}

Only active sequences visible to this user are accepted. One non-terminal enrollment may exist per lead across all sequences. Another sequence returns 409 conflict; an inactive target returns 409 conflict. Tenant checks cover both followup_enrollments.client_id and the joined lead.

Base URL https://api.leadarc.io/v1. Generated from the API source.