OrgSequencesSequenceidEnrollmentsEnrollmentidMessages

One person's planned messages

The whole conversation-to-be, in the order the sequence will happen to this person. Written at enrollment; whatever is stored here is what each step sends verbatim when it comes due. The message currently parked in the review queue is flagged `is_pending` — send or skip it there.

GET
/org/sequences/{sequenceId}/enrollments/{enrollmentId}/messages

The whole conversation-to-be, in the order the sequence will happen to this person. Written at enrollment; whatever is stored here is what each step sends verbatim when it comes due. The message currently parked in the review queue is flagged is_pending — send or skip it there.

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Path Parameters

sequenceId*string
Formatuuid
enrollmentId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/org/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/enrollments/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "node_id": "6e0bdcac-9717-4a6f-972e-97489dffeb0c",
      "node_label": "string",
      "node_kind": "string",
      "subject": "string",
      "body": "string",
      "is_pending": true
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}
{
  "error": "module_required",
  "module": "string",
  "message": "string",
  "contact": "string"
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}