Moab logoMoab
Get started
Moab Docs

Sequences

Multi-touch cadences: the steps a campaign agent walks a person through.

Base path /api/v1/sequences on https://moabcrm.com. Authenticate with Authorization: Bearer $DASH_API_KEY and name the project with the Project-ID header. Writes are validated in declared mode; an operation this resource does not declare answers 405 operation_not_supported.

List sequences

GET /api/v1/sequences

curl "https://moabcrm.com/api/v1/sequences" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Show me the sequences filtered by status
data_query {
  "collection": "sequences"
}

Returns a paginated list of sequence objects, newest first.

{
  "object": "list",
  "data": [
    {
      "object": "sequence",
      "id": "obj_123",
      "name": "name",
      "status": "status",
      "created_at": "2026-07-25T12:00:00.000Z",
      "updated_at": "2026-07-25T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Parameters

ParameterTypeKindDescription
statusstringfilterFree-text working status of the sequence definition.
product_idstringfilterThe products row this cadence sells.
agent_idstringfilterThe campaign agent that walks people through this cadence.
qstringsearchFree-text search across name.
sortstringsortOne of created_at; prefix with - to reverse.
limitnumberpageRows to return, 1–100. Defaults to 20.
cursorstringpagenext_cursor from the previous page.

Retrieve a sequence

GET /api/v1/sequences/draft-001

curl "https://moabcrm.com/api/v1/sequences/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Open the sequence {id}
data_get {
  "collection": "sequences",
  "object_id": "draft-001"
}

Returns the sequence object.

{
  "object": "sequence",
  "id": "obj_123",
  "name": "name",
  "status": "status",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

ParameterTypeKindDescription
idstringpathThe sequence's id or slug.

Create a sequence

POST /api/v1/sequences

curl -X POST "https://moabcrm.com/api/v1/sequences" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"name":"name","status":"status"}'
Create a new sequence
data_set {
  "collection": "sequences",
  "object_id": "draft-001",
  "data": {
    "name": "name",
    "status": "status"
  }
}

Returns the sequence object.

{
  "object": "sequence",
  "id": "obj_123",
  "name": "name",
  "status": "status",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the cadence.
statusstringnoFree-text working status of the sequence definition.

Update a sequence

PATCH /api/v1/sequences/draft-001

curl -X PATCH "https://moabcrm.com/api/v1/sequences/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"name":"name","status":"status"}'
Update the sequence {id}
data_set {
  "collection": "sequences",
  "object_id": "draft-001",
  "data": {
    "name": "name",
    "status": "status"
  }
}

Returns the sequence object.

{
  "object": "sequence",
  "id": "obj_123",
  "name": "name",
  "status": "status",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the cadence.
statusstringnoFree-text working status of the sequence definition.

What comes back (read-only)

Every sequence carries the envelope below. The fields under it are computed or stamped by the platform — they are returned, never sent.

FieldTypeDescription
objectstringAlways sequence.
idstringStable object id. Also accepted in place of slug on any path.
slugstringURL-safe name, unique within the collection.
created_atstringISO-8601 timestamp of the first write.
updated_atstringISO-8601 timestamp of the most recent write. The cursor sorts on this.
product_idstringThe products row this cadence sells.
agent_idstringThe campaign agent that walks people through this cadence.
stepsarrayThe ordered ladder — one entry per touch, \{ content_id, delay_days, condition \}. Definition only; per-person progress lives on people.sequence_*.
created_by_run_idstringThe campaign run that created this sequence.
created_by_agent_idstringThe campaign agent that created this sequence, read by the provenance hook.

Errors

Failures use { error: { type, code, message, param } }. The full code table is generated at Error Codes.

On this page

Moab logoMoab

Ready to build? Connect an agent and go — no credit card needed to start.

Get startedSee our plans