Retrieve a sequence message

$ lightfield sequence retrieve-message

GET/v1/sequences/{id}/messages/{messageId}

Retrieves a single sequence message by its ID: an outbound email or LinkedIn message, or an enrollment’s first reply, with its plain-text content. Content is returned with sequences:read regardless of the email’s privacy; see Sequence message access.

Required scope: sequences:read

Rate limit category: Read

ParametersExpand Collapse

--id: string

Unique identifier of the sequence.

--message-id: string

Unique identifier of the message to retrieve.

ReturnsExpand Collapse

sequence_retrieve_message_response: object { id, acceptedAt, bouncedAt, 15 more } or object { id, channel, contactId, 8 more }

Outbound message: object { id, acceptedAt, bouncedAt, 15 more }

id: string

Unique identifier of the message.

acceptedAt: string

When the connection request was accepted; null until then.

bouncedAt: string

When the email bounced; null until then.

channel: "EMAIL" or "LINKEDIN"

Channel the message went over.

"EMAIL"

"LINKEDIN"

contactId: string

ID of the contact.

content: object { body, subject }

Plain-text content of the message. Null when the underlying record is no longer available; not included in list responses.

body: string

Plain-text body; null for a connection request sent without a note.

subject: string

Email subject; null for LinkedIn.

createdAt: string

When the message was created, or when a reply was received. Lists sort by this field, newest first.

direction: "OUTBOUND"

Always OUTBOUND.

"OUTBOUND"

enrollmentId: string

ID of the enrollment the message belongs to.

openedAt: string

When the email was opened; null until then.

readAt: string

When the LinkedIn message was read; null until then.

reference: object { id, objectType } or object { id, objectType }

The email or LinkedIn message record behind this sequence message, readable with Retrieve an email or Retrieve a message under their own scopes; null when there is none.

Email: object { id, objectType }

id: string

ID of the email.

objectType: "email"

Always email.

"email"

Message: object { id, objectType }

id: string

ID of the message.

objectType: "message"

Always message.

"message"

repliedAt: string

When the contact replied to this message; null until then.

sentAt: string

When the message was sent; null until then.

sequenceStepId: string

ID of the step that sent the message or, for a reply, the step it replied to.

sequenceStepType: "EMAIL" or "LINKEDIN_MESSAGE" or "LINKEDIN_INVITE"

Type of that step.

"EMAIL"

"LINKEDIN_MESSAGE"

"LINKEDIN_INVITE"

status: "AWAITING_REVIEW" or "SCHEDULED" or "QUEUED" or 4 more

AWAITING_REVIEW is waiting for approval; SCHEDULED is composed and waiting for its send time; QUEUED is due and waiting on the sender. SENT, SKIPPED, FAILED and CANCELLED are final.

"AWAITING_REVIEW"

"SCHEDULED"

"QUEUED"

"SENT"

"SKIPPED"

"FAILED"

"CANCELLED"

statusChangedAt: string

When status last changed.

Reply: object { id, channel, contactId, 8 more }

id: string

Unique identifier of the message.

channel: "EMAIL" or "LINKEDIN"

Channel the message went over.

"EMAIL"

"LINKEDIN"

contactId: string

ID of the contact.

content: object { body, subject }

Plain-text content of the message. Null when the underlying record is no longer available; not included in list responses.

body: string

Plain-text body; null for a connection request sent without a note.

subject: string

Email subject; null for LinkedIn.

createdAt: string

When the message was created, or when a reply was received. Lists sort by this field, newest first.

direction: "INBOUND"

Always INBOUND.

"INBOUND"

enrollmentId: string

ID of the enrollment the message belongs to.

receivedAt: string

When the reply was received.

reference: object { id, objectType } or object { id, objectType }

The email or LinkedIn message record behind this sequence message, readable with Retrieve an email or Retrieve a message under their own scopes; null when there is none.

Email: object { id, objectType }

id: string

ID of the email.

objectType: "email"

Always email.

"email"

Message: object { id, objectType }

id: string

ID of the message.

objectType: "message"

Always message.

"message"

sequenceStepId: string

ID of the step that sent the message or, for a reply, the step it replied to.

sequenceStepType: "EMAIL" or "LINKEDIN_MESSAGE" or "LINKEDIN_INVITE"

Type of that step.

"EMAIL"

"LINKEDIN_MESSAGE"

"LINKEDIN_INVITE"

Retrieve a sequence message

lightfield sequence retrieve-message \
  --api-key 'My API Key' \
  --id id \
  --message-id messageId

{
  "id": "id",
  "acceptedAt": "acceptedAt",
  "bouncedAt": "bouncedAt",
  "channel": "EMAIL",
  "contactId": "contactId",
  "content": {
    "body": "body",
    "subject": "subject"
  },
  "createdAt": "createdAt",
  "direction": "OUTBOUND",
  "enrollmentId": "enrollmentId",
  "openedAt": "openedAt",
  "readAt": "readAt",
  "reference": {
    "id": "id",
    "objectType": "email"
  },
  "repliedAt": "repliedAt",
  "sentAt": "sentAt",
  "sequenceStepId": "sequenceStepId",
  "sequenceStepType": "EMAIL",
  "status": "AWAITING_REVIEW",
  "statusChangedAt": "statusChangedAt"
}

Returns Examples

{
  "id": "id",
  "acceptedAt": "acceptedAt",
  "bouncedAt": "bouncedAt",
  "channel": "EMAIL",
  "contactId": "contactId",
  "content": {
    "body": "body",
    "subject": "subject"
  },
  "createdAt": "createdAt",
  "direction": "OUTBOUND",
  "enrollmentId": "enrollmentId",
  "openedAt": "openedAt",
  "readAt": "readAt",
  "reference": {
    "id": "id",
    "objectType": "email"
  },
  "repliedAt": "repliedAt",
  "sentAt": "sentAt",
  "sequenceStepId": "sequenceStepId",
  "sequenceStepType": "EMAIL",
  "status": "AWAITING_REVIEW",
  "statusChangedAt": "statusChangedAt"
}