Sequence

Sequences are multi-step outreach cadences that send email and LinkedIn messages to enrolled contacts. A sequence is edited through its draft, published, then activated; contacts are enrolled into the published sequence. Start with Using sequences with the API for the lifecycle, the draft and version model, and a worked example.

List sequences

client.Sequence.List(ctx, query) (*SequenceListResponse, error)

GET/v1/sequences

Retrieve a sequence

client.Sequence.Get(ctx, id) (*SequenceRetrieveResponse, error)

GET/v1/sequences/{id}

Retrieve sequence performance

client.Sequence.GetPerformance(ctx, id) (*SequenceRetrievePerformanceResponse, error)

GET/v1/sequences/{id}/performance

Retrieve a sequence enrollment

client.Sequence.GetEnrollment(ctx, enrollmentID, query) (*SequenceRetrieveEnrollmentResponse, error)

GET/v1/sequences/{id}/enrollments/{enrollmentId}

List sequence enrollments

client.Sequence.ListEnrollments(ctx, id, query) (*SequenceListEnrollmentsResponse, error)

GET/v1/sequences/{id}/enrollments

List sequence messages

client.Sequence.ListMessages(ctx, id, query) (*SequenceListMessagesResponse, error)

GET/v1/sequences/{id}/messages

Retrieve a sequence message

client.Sequence.GetMessage(ctx, messageID, query) (*SequenceRetrieveMessageResponseUnion, error)

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

Enroll and cancel contacts

client.Sequence.UpdateEnrollments(ctx, id, body) (*SequenceUpdateEnrollmentsResponse, error)

POST/v1/sequences/{id}/enrollments

Start a sequence test

client.Sequence.StartTest(ctx, id, body) (*SequenceStartTestResponse, error)

POST/v1/sequences/{id}/tests

Retrieve a sequence test

client.Sequence.GetTest(ctx, testID, query) (*SequenceRetrieveTestResponse, error)

GET/v1/sequences/{id}/tests/{testId}

Create a sequence

client.Sequence.New(ctx, body) (*SequenceCreateResponse, error)

POST/v1/sequences

Activate a sequence

client.Sequence.Activate(ctx, id, body) (*SequenceActivateResponse, error)

POST/v1/sequences/{id}/activate

Deactivate a sequence

client.Sequence.Deactivate(ctx, id, body) (*SequenceDeactivateResponse, error)

POST/v1/sequences/{id}/deactivate

Retrieve a sequence draft

client.Sequence.GetDraft(ctx, id) (*SequenceRetrieveDraftResponse, error)

GET/v1/sequences/{id}/draft

Update a sequence draft

client.Sequence.UpdateDraft(ctx, id, body) (*SequenceUpdateDraftResponse, error)

POST/v1/sequences/{id}/draft

Publish a sequence draft

client.Sequence.PublishDraft(ctx, id, body) (*SequencePublishDraftResponse, error)

POST/v1/sequences/{id}/draft/publish

List template variables

client.Sequence.ListTemplateVariables(ctx) (*SequenceListTemplateVariablesResponse, error)

GET/v1/sequences/template/variables

Discard a sequence draft

client.Sequence.DiscardDraft(ctx, id, body) (*SequenceDiscardDraftResponse, error)

POST/v1/sequences/{id}/draft/discard

ModelsExpand Collapse

type SequenceActivateResponse struct{…}

ID string

Unique identifier of the sequence.

Channels []string

Channels the published steps send on; empty before the first publish.

One of the following:

const SequenceActivateResponseChannelEmail SequenceActivateResponseChannel = "EMAIL"

const SequenceActivateResponseChannelLinkedin SequenceActivateResponseChannel = "LINKEDIN"

CreatedAt string

ISO 8601 creation timestamp.

Definition SequenceActivateResponseDefinition

Published configuration, or null before the first publish.

Description string

What this version of the sequence is for.

Messaging SequenceActivateResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceActivateResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceActivateResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceActivateResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceActivateResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceActivateResponseDefinitionPriorityHigh SequenceActivateResponseDefinitionPriority = "HIGH"

const SequenceActivateResponseDefinitionPriorityNormal SequenceActivateResponseDefinitionPriority = "NORMAL"

SendWindow SequenceActivateResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceActivateResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceActivateResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceActivateResponseDefinitionStepObjectDeliveryModeAuto SequenceActivateResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceActivateResponseDefinitionStepObjectDeliveryModeForReview SequenceActivateResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceActivateResponseDefinitionStepObjectTypeEmail SequenceActivateResponseDefinitionStepObjectType = "EMAIL"

const SequenceActivateResponseDefinitionStepObjectTypeLinkedinMessage SequenceActivateResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceActivateResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceActivateResponseDefinitionStepObject2DeliveryModeAuto SequenceActivateResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceActivateResponseDefinitionStepObject2DeliveryModeForReview SequenceActivateResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceActivateResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceActivateResponseDefinitionStepObject3DeliveryModeAuto SequenceActivateResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceActivateResponseDefinitionStepObject3DeliveryModeForReview SequenceActivateResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceActivateResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Email body as Markdown, without the sign-off or signature, which are added when the message is written. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

Subject string

Plain-text subject line. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

Type string

Step type.

type SequenceActivateResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceActivateResponseDefinitionStepObject4DeliveryModeAuto SequenceActivateResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceActivateResponseDefinitionStepObject4DeliveryModeForReview SequenceActivateResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceActivateResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Plain-text message. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

Type string

Step type.

type SequenceActivateResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceActivateResponseDefinitionStepObject5DeliveryModeAuto SequenceActivateResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceActivateResponseDefinitionStepObject5DeliveryModeForReview SequenceActivateResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceActivateResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceActivateResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceActivateResponseDefinitionStepObject6TypeWait SequenceActivateResponseDefinitionStepObject6Type = "WAIT"

const SequenceActivateResponseDefinitionStepObject6TypeWaitForConnection SequenceActivateResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceActivateResponseDefinitionStepObject6UnitDay SequenceActivateResponseDefinitionStepObject6Unit = "DAY"

const SequenceActivateResponseDefinitionStepObject6UnitMinute SequenceActivateResponseDefinitionStepObject6Unit = "MINUTE"

FirstActivatedAt string

When the sequence was first activated.

LastActivatedAt string

When the sequence was most recently activated.

Name string

Name of the sequence.

ObjectType SequenceActivateResponseObjectType

Always sequence.

Reviewers []SequenceActivateResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceActivateResponseSender

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

Status SequenceActivateResponseStatus

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

const SequenceActivateResponseStatusDraft SequenceActivateResponseStatus = "DRAFT"

const SequenceActivateResponseStatusActive SequenceActivateResponseStatus = "ACTIVE"

const SequenceActivateResponseStatusDeactivated SequenceActivateResponseStatus = "DEACTIVATED"

type SequenceCreateResponse struct{…}

Channels []string

Channels the draft’s steps send on.

One of the following:

const SequenceCreateResponseChannelEmail SequenceCreateResponseChannel = "EMAIL"

const SequenceCreateResponseChannelLinkedin SequenceCreateResponseChannel = "LINKEDIN"

Definition SequenceCreateResponseDefinition

The draft configuration, in the same shape as a published definition.

Description string

What this version of the sequence is for.

Messaging SequenceCreateResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceCreateResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceCreateResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceCreateResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceCreateResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceCreateResponseDefinitionPriorityHigh SequenceCreateResponseDefinitionPriority = "HIGH"

const SequenceCreateResponseDefinitionPriorityNormal SequenceCreateResponseDefinitionPriority = "NORMAL"

SendWindow SequenceCreateResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceCreateResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceCreateResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceCreateResponseDefinitionStepObjectDeliveryModeAuto SequenceCreateResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceCreateResponseDefinitionStepObjectDeliveryModeForReview SequenceCreateResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceCreateResponseDefinitionStepObjectTypeEmail SequenceCreateResponseDefinitionStepObjectType = "EMAIL"

const SequenceCreateResponseDefinitionStepObjectTypeLinkedinMessage SequenceCreateResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceCreateResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceCreateResponseDefinitionStepObject2DeliveryModeAuto SequenceCreateResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceCreateResponseDefinitionStepObject2DeliveryModeForReview SequenceCreateResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceCreateResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceCreateResponseDefinitionStepObject3DeliveryModeAuto SequenceCreateResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceCreateResponseDefinitionStepObject3DeliveryModeForReview SequenceCreateResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceCreateResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceCreateResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceCreateResponseDefinitionStepObject4DeliveryModeAuto SequenceCreateResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceCreateResponseDefinitionStepObject4DeliveryModeForReview SequenceCreateResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceCreateResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceCreateResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceCreateResponseDefinitionStepObject5DeliveryModeAuto SequenceCreateResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceCreateResponseDefinitionStepObject5DeliveryModeForReview SequenceCreateResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceCreateResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceCreateResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceCreateResponseDefinitionStepObject6TypeWait SequenceCreateResponseDefinitionStepObject6Type = "WAIT"

const SequenceCreateResponseDefinitionStepObject6TypeWaitForConnection SequenceCreateResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceCreateResponseDefinitionStepObject6UnitDay SequenceCreateResponseDefinitionStepObject6Unit = "DAY"

const SequenceCreateResponseDefinitionStepObject6UnitMinute SequenceCreateResponseDefinitionStepObject6Unit = "MINUTE"

Name string

Name the sequence takes when the draft is published.

PublishWarnings []SequenceCreateResponsePublishWarning

What publishing this draft would change for contacts already in the sequence; empty when nothing is affected. Before the first publish, the only possible warning is a proposed sender that was archived and would be left off.

Code string

What publishing would change.

One of the following:

const SequenceCreateResponsePublishWarningCodeDelayShortened SequenceCreateResponsePublishWarningCode = "delay_shortened"

const SequenceCreateResponsePublishWarningCodeDelayLengthened SequenceCreateResponsePublishWarningCode = "delay_lengthened"

const SequenceCreateResponsePublishWarningCodeConnectionWaitShortened SequenceCreateResponsePublishWarningCode = "connection_wait_shortened"

const SequenceCreateResponsePublishWarningCodeConnectionWaitLengthened SequenceCreateResponsePublishWarningCode = "connection_wait_lengthened"

const SequenceCreateResponsePublishWarningCodeSendScheduleChanged SequenceCreateResponsePublishWarningCode = "send_schedule_changed"

const SequenceCreateResponsePublishWarningCodeSendConfigurationChanged SequenceCreateResponsePublishWarningCode = "send_configuration_changed"

const SequenceCreateResponsePublishWarningCodeSendPriorityChanged SequenceCreateResponsePublishWarningCode = "send_priority_changed"

const SequenceCreateResponsePublishWarningCodeSendersChanged SequenceCreateResponsePublishWarningCode = "senders_changed"

const SequenceCreateResponsePublishWarningCodeEmailSenderPoolEmptied SequenceCreateResponsePublishWarningCode = "email_sender_pool_emptied"

const SequenceCreateResponsePublishWarningCodeLinkedinAccountPoolEmptied SequenceCreateResponsePublishWarningCode = "linkedin_account_pool_emptied"

const SequenceCreateResponsePublishWarningCodeAssignedSenderRemoved SequenceCreateResponsePublishWarningCode = "assigned_sender_removed"

const SequenceCreateResponsePublishWarningCodeDeliveryBecameAutomatic SequenceCreateResponsePublishWarningCode = "delivery_became_automatic"

const SequenceCreateResponsePublishWarningCodeInviteNoteEnabled SequenceCreateResponsePublishWarningCode = "invite_note_enabled"

const SequenceCreateResponsePublishWarningCodeInviteNoteDisabled SequenceCreateResponsePublishWarningCode = "invite_note_disabled"

const SequenceCreateResponsePublishWarningCodeStepInserted SequenceCreateResponsePublishWarningCode = "step_inserted"

const SequenceCreateResponsePublishWarningCodeAutomaticSendStepInserted SequenceCreateResponsePublishWarningCode = "automatic_send_step_inserted"

const SequenceCreateResponsePublishWarningCodeStepRemoved SequenceCreateResponsePublishWarningCode = "step_removed"

const SequenceCreateResponsePublishWarningCodeStepTypeChanged SequenceCreateResponsePublishWarningCode = "step_type_changed"

const SequenceCreateResponsePublishWarningCodeStepOrderChanged SequenceCreateResponsePublishWarningCode = "step_order_changed"

const SequenceCreateResponsePublishWarningCodeFullIdentityRewrite SequenceCreateResponsePublishWarningCode = "full_identity_rewrite"

const SequenceCreateResponsePublishWarningCodeLowIdentityOverlap SequenceCreateResponsePublishWarningCode = "low_identity_overlap"

Message string

What would change, in plain language.

Severity string

destructive when contacts already in the sequence may skip, repeat or receive a step they would not have; warning otherwise.

One of the following:

const SequenceCreateResponsePublishWarningSeverityWarning SequenceCreateResponsePublishWarningSeverity = "warning"

const SequenceCreateResponsePublishWarningSeverityDestructive SequenceCreateResponsePublishWarningSeverity = "destructive"

StepIDs []string

The steps involved; empty for a sequence-wide change.

Reviewers []SequenceCreateResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceCreateResponseSender

The senders this draft will publish; new contacts rotate across them. Until a save changes it, this is the sequence’s live list. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

SequenceID string

The sequence this draft belongs to.

UpdatedAt string

When the draft last changed.

Version string

Opaque token for the current state of the draft. Send it as expectedVersion on the next save, publish or discard; it changes whenever anyone edits the draft.

type SequenceDeactivateResponse struct{…}

ID string

Unique identifier of the sequence.

Channels []string

Channels the published steps send on; empty before the first publish.

One of the following:

const SequenceDeactivateResponseChannelEmail SequenceDeactivateResponseChannel = "EMAIL"

const SequenceDeactivateResponseChannelLinkedin SequenceDeactivateResponseChannel = "LINKEDIN"

CreatedAt string

ISO 8601 creation timestamp.

Definition SequenceDeactivateResponseDefinition

Published configuration, or null before the first publish.

Description string

What this version of the sequence is for.

Messaging SequenceDeactivateResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceDeactivateResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceDeactivateResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceDeactivateResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceDeactivateResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceDeactivateResponseDefinitionPriorityHigh SequenceDeactivateResponseDefinitionPriority = "HIGH"

const SequenceDeactivateResponseDefinitionPriorityNormal SequenceDeactivateResponseDefinitionPriority = "NORMAL"

SendWindow SequenceDeactivateResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceDeactivateResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceDeactivateResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceDeactivateResponseDefinitionStepObjectDeliveryModeAuto SequenceDeactivateResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceDeactivateResponseDefinitionStepObjectDeliveryModeForReview SequenceDeactivateResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceDeactivateResponseDefinitionStepObjectTypeEmail SequenceDeactivateResponseDefinitionStepObjectType = "EMAIL"

const SequenceDeactivateResponseDefinitionStepObjectTypeLinkedinMessage SequenceDeactivateResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceDeactivateResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject2DeliveryModeAuto SequenceDeactivateResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceDeactivateResponseDefinitionStepObject2DeliveryModeForReview SequenceDeactivateResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceDeactivateResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject3DeliveryModeAuto SequenceDeactivateResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceDeactivateResponseDefinitionStepObject3DeliveryModeForReview SequenceDeactivateResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceDeactivateResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceDeactivateResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject4DeliveryModeAuto SequenceDeactivateResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceDeactivateResponseDefinitionStepObject4DeliveryModeForReview SequenceDeactivateResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceDeactivateResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceDeactivateResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject5DeliveryModeAuto SequenceDeactivateResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceDeactivateResponseDefinitionStepObject5DeliveryModeForReview SequenceDeactivateResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceDeactivateResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceDeactivateResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject6TypeWait SequenceDeactivateResponseDefinitionStepObject6Type = "WAIT"

const SequenceDeactivateResponseDefinitionStepObject6TypeWaitForConnection SequenceDeactivateResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceDeactivateResponseDefinitionStepObject6UnitDay SequenceDeactivateResponseDefinitionStepObject6Unit = "DAY"

const SequenceDeactivateResponseDefinitionStepObject6UnitMinute SequenceDeactivateResponseDefinitionStepObject6Unit = "MINUTE"

FirstActivatedAt string

When the sequence was first activated.

LastActivatedAt string

When the sequence was most recently activated.

Name string

Name of the sequence.

ObjectType SequenceDeactivateResponseObjectType

Always sequence.

Reviewers []SequenceDeactivateResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceDeactivateResponseSender

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

Status SequenceDeactivateResponseStatus

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

const SequenceDeactivateResponseStatusDraft SequenceDeactivateResponseStatus = "DRAFT"

const SequenceDeactivateResponseStatusActive SequenceDeactivateResponseStatus = "ACTIVE"

const SequenceDeactivateResponseStatusDeactivated SequenceDeactivateResponseStatus = "DEACTIVATED"

type SequenceDiscardDraftResponse struct{…}

SequenceDeleted bool

True when the sequence had never been published, so discarding its only draft deleted it.

SequenceID string

The sequence whose draft was discarded.

type SequenceListEnrollmentsResponse struct{…}

Data []SequenceListEnrollmentsResponseData

ID string

Unique identifier of the enrollment.

CancelledAt string

When the enrollment was cancelled, or null if it was not.

CompletedAt string

When the enrollment completed, or null if it has not.

ContactID string

ID of the enrolled contact.

CurrentStepID string

ID of the step the contact is on, matching definition.steps; null when the contact has no current step the API returns.

EnrolledAt string

When the contact was enrolled.

EnrolledBy string

Member ID of whoever enrolled the contact; null when they are no longer a member or the enrollment was automatic.

LastActivityAt string

When lastActivityKind happened; null when there has been no activity.

LastActivityKind string

The latest activity on the enrollment. A reply or bounce that ended the enrollment is reported over a later open.

One of the following:

const SequenceListEnrollmentsResponseDataLastActivityKindSent SequenceListEnrollmentsResponseDataLastActivityKind = "SENT"

const SequenceListEnrollmentsResponseDataLastActivityKindOpened SequenceListEnrollmentsResponseDataLastActivityKind = "OPENED"

const SequenceListEnrollmentsResponseDataLastActivityKindReplied SequenceListEnrollmentsResponseDataLastActivityKind = "REPLIED"

const SequenceListEnrollmentsResponseDataLastActivityKindBounced SequenceListEnrollmentsResponseDataLastActivityKind = "BOUNCED"

const SequenceListEnrollmentsResponseDataLastActivityKindInvited SequenceListEnrollmentsResponseDataLastActivityKind = "INVITED"

const SequenceListEnrollmentsResponseDataLastActivityKindConnected SequenceListEnrollmentsResponseDataLastActivityKind = "CONNECTED"

const SequenceListEnrollmentsResponseDataLastActivityKindSeen SequenceListEnrollmentsResponseDataLastActivityKind = "SEEN"

NextSendAt string

Estimated time of the next send, from the cadence, send window, pacing and sender; queue order and random gaps can push it later. Null while a message awaits review or is sending, while paused, or when it cannot be estimated.

RemainingSends int64

Email and LinkedIn steps not yet sent, connection requests included.

minimum-9007199254740991

maximum9007199254740991

RepliedAt string

When the contact first replied, on email or LinkedIn; null if they have not.

Status string

ACTIVE is progressing; AWAITING_REVIEW has a message waiting for approval; NEEDS_ATTENTION is held by a failed step, a held draft or an unavailable sender; PAUSED is stopped because the sequence is deactivated or it was paused in Lightfield. REPLIED, COMPLETED, CANCELLED and FAILED are final.

One of the following:

const SequenceListEnrollmentsResponseDataStatusActive SequenceListEnrollmentsResponseDataStatus = "ACTIVE"

const SequenceListEnrollmentsResponseDataStatusAwaitingReview SequenceListEnrollmentsResponseDataStatus = "AWAITING_REVIEW"

const SequenceListEnrollmentsResponseDataStatusNeedsAttention SequenceListEnrollmentsResponseDataStatus = "NEEDS_ATTENTION"

const SequenceListEnrollmentsResponseDataStatusReplied SequenceListEnrollmentsResponseDataStatus = "REPLIED"

const SequenceListEnrollmentsResponseDataStatusCompleted SequenceListEnrollmentsResponseDataStatus = "COMPLETED"

const SequenceListEnrollmentsResponseDataStatusPaused SequenceListEnrollmentsResponseDataStatus = "PAUSED"

const SequenceListEnrollmentsResponseDataStatusCancelled SequenceListEnrollmentsResponseDataStatus = "CANCELLED"

const SequenceListEnrollmentsResponseDataStatusFailed SequenceListEnrollmentsResponseDataStatus = "FAILED"

Object SequenceListEnrollmentsResponseObject

TotalCount int64

minimum-9007199254740991

maximum9007199254740991

type SequenceListMessagesResponse struct{…}

Data []SequenceListMessagesResponseDataUnion

One of the following:

type SequenceListMessagesResponseDataOutboundMessage struct{…}

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 string

Channel the message went over.

One of the following:

const SequenceListMessagesResponseDataOutboundMessageChannelEmail SequenceListMessagesResponseDataOutboundMessageChannel = "EMAIL"

const SequenceListMessagesResponseDataOutboundMessageChannelLinkedin SequenceListMessagesResponseDataOutboundMessageChannel = "LINKEDIN"

ContactID string

ID of the contact.

CreatedAt string

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

Direction string

Always 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 SequenceListMessagesResponseDataOutboundMessageReferenceUnion

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.

One of the following:

type SequenceListMessagesResponseDataOutboundMessageReferenceEmail struct{…}

ID string

ID of the email.

ObjectType string

Always email.

type SequenceListMessagesResponseDataOutboundMessageReferenceMessage struct{…}

ID string

ID of the message.

ObjectType string

Always 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 string

Type of that step.

One of the following:

const SequenceListMessagesResponseDataOutboundMessageSequenceStepTypeEmail SequenceListMessagesResponseDataOutboundMessageSequenceStepType = "EMAIL"

const SequenceListMessagesResponseDataOutboundMessageSequenceStepTypeLinkedinMessage SequenceListMessagesResponseDataOutboundMessageSequenceStepType = "LINKEDIN_MESSAGE"

const SequenceListMessagesResponseDataOutboundMessageSequenceStepTypeLinkedinInvite SequenceListMessagesResponseDataOutboundMessageSequenceStepType = "LINKEDIN_INVITE"

Status string

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.

One of the following:

const SequenceListMessagesResponseDataOutboundMessageStatusAwaitingReview SequenceListMessagesResponseDataOutboundMessageStatus = "AWAITING_REVIEW"

const SequenceListMessagesResponseDataOutboundMessageStatusScheduled SequenceListMessagesResponseDataOutboundMessageStatus = "SCHEDULED"

const SequenceListMessagesResponseDataOutboundMessageStatusQueued SequenceListMessagesResponseDataOutboundMessageStatus = "QUEUED"

const SequenceListMessagesResponseDataOutboundMessageStatusSent SequenceListMessagesResponseDataOutboundMessageStatus = "SENT"

const SequenceListMessagesResponseDataOutboundMessageStatusSkipped SequenceListMessagesResponseDataOutboundMessageStatus = "SKIPPED"

const SequenceListMessagesResponseDataOutboundMessageStatusFailed SequenceListMessagesResponseDataOutboundMessageStatus = "FAILED"

const SequenceListMessagesResponseDataOutboundMessageStatusCancelled SequenceListMessagesResponseDataOutboundMessageStatus = "CANCELLED"

StatusChangedAt string

When status last changed.

type SequenceListMessagesResponseDataReply struct{…}

ID string

Unique identifier of the message.

Channel string

Channel the message went over.

One of the following:

const SequenceListMessagesResponseDataReplyChannelEmail SequenceListMessagesResponseDataReplyChannel = "EMAIL"

const SequenceListMessagesResponseDataReplyChannelLinkedin SequenceListMessagesResponseDataReplyChannel = "LINKEDIN"

ContactID string

ID of the contact.

CreatedAt string

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

Direction string

Always INBOUND.

EnrollmentID string

ID of the enrollment the message belongs to.

ReceivedAt string

When the reply was received.

Reference SequenceListMessagesResponseDataReplyReferenceUnion

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.

One of the following:

type SequenceListMessagesResponseDataReplyReferenceEmail struct{…}

ID string

ID of the email.

ObjectType string

Always email.

type SequenceListMessagesResponseDataReplyReferenceMessage struct{…}

ID string

ID of the message.

ObjectType string

Always message.

SequenceStepID string

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

SequenceStepType string

Type of that step.

One of the following:

const SequenceListMessagesResponseDataReplySequenceStepTypeEmail SequenceListMessagesResponseDataReplySequenceStepType = "EMAIL"

const SequenceListMessagesResponseDataReplySequenceStepTypeLinkedinMessage SequenceListMessagesResponseDataReplySequenceStepType = "LINKEDIN_MESSAGE"

const SequenceListMessagesResponseDataReplySequenceStepTypeLinkedinInvite SequenceListMessagesResponseDataReplySequenceStepType = "LINKEDIN_INVITE"

Object SequenceListMessagesResponseObject

TotalCount int64

minimum-9007199254740991

maximum9007199254740991

type SequenceListResponse struct{…}

Data []SequenceListResponseData

ID string

Unique identifier of the sequence.

Channels []string

Channels the published steps send on; empty before the first publish.

One of the following:

const SequenceListResponseDataChannelEmail SequenceListResponseDataChannel = "EMAIL"

const SequenceListResponseDataChannelLinkedin SequenceListResponseDataChannel = "LINKEDIN"

CreatedAt string

ISO 8601 creation timestamp.

Definition SequenceListResponseDataDefinition

Published configuration, or null before the first publish.

Description string

What this version of the sequence is for.

Messaging SequenceListResponseDataDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceListResponseDataDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceListResponseDataDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceListResponseDataDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceListResponseDataDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceListResponseDataDefinitionPriorityHigh SequenceListResponseDataDefinitionPriority = "HIGH"

const SequenceListResponseDataDefinitionPriorityNormal SequenceListResponseDataDefinitionPriority = "NORMAL"

SendWindow SequenceListResponseDataDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceListResponseDataDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceListResponseDataDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceListResponseDataDefinitionStepObjectDeliveryModeAuto SequenceListResponseDataDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceListResponseDataDefinitionStepObjectDeliveryModeForReview SequenceListResponseDataDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceListResponseDataDefinitionStepObjectTypeEmail SequenceListResponseDataDefinitionStepObjectType = "EMAIL"

const SequenceListResponseDataDefinitionStepObjectTypeLinkedinMessage SequenceListResponseDataDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceListResponseDataDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceListResponseDataDefinitionStepObject2DeliveryModeAuto SequenceListResponseDataDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceListResponseDataDefinitionStepObject2DeliveryModeForReview SequenceListResponseDataDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceListResponseDataDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceListResponseDataDefinitionStepObject3DeliveryModeAuto SequenceListResponseDataDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceListResponseDataDefinitionStepObject3DeliveryModeForReview SequenceListResponseDataDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceListResponseDataDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceListResponseDataDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceListResponseDataDefinitionStepObject4DeliveryModeAuto SequenceListResponseDataDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceListResponseDataDefinitionStepObject4DeliveryModeForReview SequenceListResponseDataDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceListResponseDataDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceListResponseDataDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceListResponseDataDefinitionStepObject5DeliveryModeAuto SequenceListResponseDataDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceListResponseDataDefinitionStepObject5DeliveryModeForReview SequenceListResponseDataDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceListResponseDataDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceListResponseDataDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceListResponseDataDefinitionStepObject6TypeWait SequenceListResponseDataDefinitionStepObject6Type = "WAIT"

const SequenceListResponseDataDefinitionStepObject6TypeWaitForConnection SequenceListResponseDataDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceListResponseDataDefinitionStepObject6UnitDay SequenceListResponseDataDefinitionStepObject6Unit = "DAY"

const SequenceListResponseDataDefinitionStepObject6UnitMinute SequenceListResponseDataDefinitionStepObject6Unit = "MINUTE"

FirstActivatedAt string

When the sequence was first activated.

LastActivatedAt string

When the sequence was most recently activated.

Name string

Name of the sequence.

ObjectType string

Always sequence.

Reviewers []SequenceListResponseDataReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceListResponseDataSender

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

Status string

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

const SequenceListResponseDataStatusDraft SequenceListResponseDataStatus = "DRAFT"

const SequenceListResponseDataStatusActive SequenceListResponseDataStatus = "ACTIVE"

const SequenceListResponseDataStatusDeactivated SequenceListResponseDataStatus = "DEACTIVATED"

Object SequenceListResponseObject

TotalCount int64

minimum-9007199254740991

maximum9007199254740991

type SequenceListTemplateVariablesResponse struct{…}

Data []SequenceListTemplateVariablesResponseData

Field SequenceListTemplateVariablesResponseDataField

The field the variable reads; null for built-in variables.

ID string

The ad_ id of the field, as the field-definitions endpoints list it.

ValueType string

Type of the field.

One of the following:

const SequenceListTemplateVariablesResponseDataFieldValueTypeAddress SequenceListTemplateVariablesResponseDataFieldValueType = "ADDRESS"

const SequenceListTemplateVariablesResponseDataFieldValueTypeCheckbox SequenceListTemplateVariablesResponseDataFieldValueType = "CHECKBOX"

const SequenceListTemplateVariablesResponseDataFieldValueTypeCurrency SequenceListTemplateVariablesResponseDataFieldValueType = "CURRENCY"

const SequenceListTemplateVariablesResponseDataFieldValueTypeDatetime SequenceListTemplateVariablesResponseDataFieldValueType = "DATETIME"

const SequenceListTemplateVariablesResponseDataFieldValueTypeEmail SequenceListTemplateVariablesResponseDataFieldValueType = "EMAIL"

const SequenceListTemplateVariablesResponseDataFieldValueTypeFullName SequenceListTemplateVariablesResponseDataFieldValueType = "FULL_NAME"

const SequenceListTemplateVariablesResponseDataFieldValueTypeMarkdown SequenceListTemplateVariablesResponseDataFieldValueType = "MARKDOWN"

const SequenceListTemplateVariablesResponseDataFieldValueTypeMultiSelect SequenceListTemplateVariablesResponseDataFieldValueType = "MULTI_SELECT"

const SequenceListTemplateVariablesResponseDataFieldValueTypeNumber SequenceListTemplateVariablesResponseDataFieldValueType = "NUMBER"

const SequenceListTemplateVariablesResponseDataFieldValueTypeSingleSelect SequenceListTemplateVariablesResponseDataFieldValueType = "SINGLE_SELECT"

const SequenceListTemplateVariablesResponseDataFieldValueTypeSocialHandle SequenceListTemplateVariablesResponseDataFieldValueType = "SOCIAL_HANDLE"

const SequenceListTemplateVariablesResponseDataFieldValueTypeTelephone SequenceListTemplateVariablesResponseDataFieldValueType = "TELEPHONE"

const SequenceListTemplateVariablesResponseDataFieldValueTypeText SequenceListTemplateVariablesResponseDataFieldValueType = "TEXT"

const SequenceListTemplateVariablesResponseDataFieldValueTypeURL SequenceListTemplateVariablesResponseDataFieldValueType = "URL"

const SequenceListTemplateVariablesResponseDataFieldValueTypeHTML SequenceListTemplateVariablesResponseDataFieldValueType = "HTML"

Group string

Whose value the variable prints: the enrolled contact, its first account, or the step’s sender.

One of the following:

const SequenceListTemplateVariablesResponseDataGroupContact SequenceListTemplateVariablesResponseDataGroup = "contact"

const SequenceListTemplateVariablesResponseDataGroupAccount SequenceListTemplateVariablesResponseDataGroup = "account"

const SequenceListTemplateVariablesResponseDataGroupSender SequenceListTemplateVariablesResponseDataGroup = "sender"

Label string

Name of the variable, as the editor shows it.

Ref string

The variable, e.g. {{ {attr:ad_…} }}. A variable needs a fallback for contacts missing the value: {{ {attr:ad_…} }} is written {{ coalesce({attr:ad_…}, "fallback") }}, and one without a fallback is refused when the draft is saved.

Object SequenceListTemplateVariablesResponseObject

TotalCount int64

minimum-9007199254740991

maximum9007199254740991

type SequencePublishDraftResponse struct{…}

ID string

Unique identifier of the sequence.

Channels []string

Channels the published steps send on; empty before the first publish.

One of the following:

const SequencePublishDraftResponseChannelEmail SequencePublishDraftResponseChannel = "EMAIL"

const SequencePublishDraftResponseChannelLinkedin SequencePublishDraftResponseChannel = "LINKEDIN"

CreatedAt string

ISO 8601 creation timestamp.

Definition SequencePublishDraftResponseDefinition

Published configuration, or null before the first publish.

Description string

What this version of the sequence is for.

Messaging SequencePublishDraftResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequencePublishDraftResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequencePublishDraftResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequencePublishDraftResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequencePublishDraftResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequencePublishDraftResponseDefinitionPriorityHigh SequencePublishDraftResponseDefinitionPriority = "HIGH"

const SequencePublishDraftResponseDefinitionPriorityNormal SequencePublishDraftResponseDefinitionPriority = "NORMAL"

SendWindow SequencePublishDraftResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequencePublishDraftResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequencePublishDraftResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequencePublishDraftResponseDefinitionStepObjectDeliveryModeAuto SequencePublishDraftResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequencePublishDraftResponseDefinitionStepObjectDeliveryModeForReview SequencePublishDraftResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequencePublishDraftResponseDefinitionStepObjectTypeEmail SequencePublishDraftResponseDefinitionStepObjectType = "EMAIL"

const SequencePublishDraftResponseDefinitionStepObjectTypeLinkedinMessage SequencePublishDraftResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequencePublishDraftResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject2DeliveryModeAuto SequencePublishDraftResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequencePublishDraftResponseDefinitionStepObject2DeliveryModeForReview SequencePublishDraftResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequencePublishDraftResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject3DeliveryModeAuto SequencePublishDraftResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequencePublishDraftResponseDefinitionStepObject3DeliveryModeForReview SequencePublishDraftResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequencePublishDraftResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequencePublishDraftResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject4DeliveryModeAuto SequencePublishDraftResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequencePublishDraftResponseDefinitionStepObject4DeliveryModeForReview SequencePublishDraftResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequencePublishDraftResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequencePublishDraftResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject5DeliveryModeAuto SequencePublishDraftResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequencePublishDraftResponseDefinitionStepObject5DeliveryModeForReview SequencePublishDraftResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequencePublishDraftResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequencePublishDraftResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject6TypeWait SequencePublishDraftResponseDefinitionStepObject6Type = "WAIT"

const SequencePublishDraftResponseDefinitionStepObject6TypeWaitForConnection SequencePublishDraftResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequencePublishDraftResponseDefinitionStepObject6UnitDay SequencePublishDraftResponseDefinitionStepObject6Unit = "DAY"

const SequencePublishDraftResponseDefinitionStepObject6UnitMinute SequencePublishDraftResponseDefinitionStepObject6Unit = "MINUTE"

FirstActivatedAt string

When the sequence was first activated.

LastActivatedAt string

When the sequence was most recently activated.

Name string

Name of the sequence.

ObjectType SequencePublishDraftResponseObjectType

Always sequence.

Reviewers []SequencePublishDraftResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequencePublishDraftResponseSender

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

Status SequencePublishDraftResponseStatus

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

const SequencePublishDraftResponseStatusDraft SequencePublishDraftResponseStatus = "DRAFT"

const SequencePublishDraftResponseStatusActive SequencePublishDraftResponseStatus = "ACTIVE"

const SequencePublishDraftResponseStatusDeactivated SequencePublishDraftResponseStatus = "DEACTIVATED"

type SequenceRetrieveDraftResponse struct{…}

Channels []string

Channels the draft’s steps send on.

One of the following:

const SequenceRetrieveDraftResponseChannelEmail SequenceRetrieveDraftResponseChannel = "EMAIL"

const SequenceRetrieveDraftResponseChannelLinkedin SequenceRetrieveDraftResponseChannel = "LINKEDIN"

Definition SequenceRetrieveDraftResponseDefinition

The draft configuration, in the same shape as a published definition.

Description string

What this version of the sequence is for.

Messaging SequenceRetrieveDraftResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceRetrieveDraftResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceRetrieveDraftResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceRetrieveDraftResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceRetrieveDraftResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceRetrieveDraftResponseDefinitionPriorityHigh SequenceRetrieveDraftResponseDefinitionPriority = "HIGH"

const SequenceRetrieveDraftResponseDefinitionPriorityNormal SequenceRetrieveDraftResponseDefinitionPriority = "NORMAL"

SendWindow SequenceRetrieveDraftResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceRetrieveDraftResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceRetrieveDraftResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObjectDeliveryModeAuto SequenceRetrieveDraftResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceRetrieveDraftResponseDefinitionStepObjectDeliveryModeForReview SequenceRetrieveDraftResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObjectTypeEmail SequenceRetrieveDraftResponseDefinitionStepObjectType = "EMAIL"

const SequenceRetrieveDraftResponseDefinitionStepObjectTypeLinkedinMessage SequenceRetrieveDraftResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceRetrieveDraftResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject2DeliveryModeAuto SequenceRetrieveDraftResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceRetrieveDraftResponseDefinitionStepObject2DeliveryModeForReview SequenceRetrieveDraftResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceRetrieveDraftResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject3DeliveryModeAuto SequenceRetrieveDraftResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceRetrieveDraftResponseDefinitionStepObject3DeliveryModeForReview SequenceRetrieveDraftResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveDraftResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceRetrieveDraftResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject4DeliveryModeAuto SequenceRetrieveDraftResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceRetrieveDraftResponseDefinitionStepObject4DeliveryModeForReview SequenceRetrieveDraftResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveDraftResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceRetrieveDraftResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject5DeliveryModeAuto SequenceRetrieveDraftResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceRetrieveDraftResponseDefinitionStepObject5DeliveryModeForReview SequenceRetrieveDraftResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveDraftResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceRetrieveDraftResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject6TypeWait SequenceRetrieveDraftResponseDefinitionStepObject6Type = "WAIT"

const SequenceRetrieveDraftResponseDefinitionStepObject6TypeWaitForConnection SequenceRetrieveDraftResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceRetrieveDraftResponseDefinitionStepObject6UnitDay SequenceRetrieveDraftResponseDefinitionStepObject6Unit = "DAY"

const SequenceRetrieveDraftResponseDefinitionStepObject6UnitMinute SequenceRetrieveDraftResponseDefinitionStepObject6Unit = "MINUTE"

Name string

Name the sequence takes when the draft is published.

PublishWarnings []SequenceRetrieveDraftResponsePublishWarning

Code string

What publishing would change.

One of the following:

const SequenceRetrieveDraftResponsePublishWarningCodeDelayShortened SequenceRetrieveDraftResponsePublishWarningCode = "delay_shortened"

const SequenceRetrieveDraftResponsePublishWarningCodeDelayLengthened SequenceRetrieveDraftResponsePublishWarningCode = "delay_lengthened"

const SequenceRetrieveDraftResponsePublishWarningCodeConnectionWaitShortened SequenceRetrieveDraftResponsePublishWarningCode = "connection_wait_shortened"

const SequenceRetrieveDraftResponsePublishWarningCodeConnectionWaitLengthened SequenceRetrieveDraftResponsePublishWarningCode = "connection_wait_lengthened"

const SequenceRetrieveDraftResponsePublishWarningCodeSendScheduleChanged SequenceRetrieveDraftResponsePublishWarningCode = "send_schedule_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeSendConfigurationChanged SequenceRetrieveDraftResponsePublishWarningCode = "send_configuration_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeSendPriorityChanged SequenceRetrieveDraftResponsePublishWarningCode = "send_priority_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeSendersChanged SequenceRetrieveDraftResponsePublishWarningCode = "senders_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeEmailSenderPoolEmptied SequenceRetrieveDraftResponsePublishWarningCode = "email_sender_pool_emptied"

const SequenceRetrieveDraftResponsePublishWarningCodeLinkedinAccountPoolEmptied SequenceRetrieveDraftResponsePublishWarningCode = "linkedin_account_pool_emptied"

const SequenceRetrieveDraftResponsePublishWarningCodeAssignedSenderRemoved SequenceRetrieveDraftResponsePublishWarningCode = "assigned_sender_removed"

const SequenceRetrieveDraftResponsePublishWarningCodeDeliveryBecameAutomatic SequenceRetrieveDraftResponsePublishWarningCode = "delivery_became_automatic"

const SequenceRetrieveDraftResponsePublishWarningCodeInviteNoteEnabled SequenceRetrieveDraftResponsePublishWarningCode = "invite_note_enabled"

const SequenceRetrieveDraftResponsePublishWarningCodeInviteNoteDisabled SequenceRetrieveDraftResponsePublishWarningCode = "invite_note_disabled"

const SequenceRetrieveDraftResponsePublishWarningCodeStepInserted SequenceRetrieveDraftResponsePublishWarningCode = "step_inserted"

const SequenceRetrieveDraftResponsePublishWarningCodeAutomaticSendStepInserted SequenceRetrieveDraftResponsePublishWarningCode = "automatic_send_step_inserted"

const SequenceRetrieveDraftResponsePublishWarningCodeStepRemoved SequenceRetrieveDraftResponsePublishWarningCode = "step_removed"

const SequenceRetrieveDraftResponsePublishWarningCodeStepTypeChanged SequenceRetrieveDraftResponsePublishWarningCode = "step_type_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeStepOrderChanged SequenceRetrieveDraftResponsePublishWarningCode = "step_order_changed"

const SequenceRetrieveDraftResponsePublishWarningCodeFullIdentityRewrite SequenceRetrieveDraftResponsePublishWarningCode = "full_identity_rewrite"

const SequenceRetrieveDraftResponsePublishWarningCodeLowIdentityOverlap SequenceRetrieveDraftResponsePublishWarningCode = "low_identity_overlap"

Message string

What would change, in plain language.

Severity string

destructive when contacts already in the sequence may skip, repeat or receive a step they would not have; warning otherwise.

One of the following:

const SequenceRetrieveDraftResponsePublishWarningSeverityWarning SequenceRetrieveDraftResponsePublishWarningSeverity = "warning"

const SequenceRetrieveDraftResponsePublishWarningSeverityDestructive SequenceRetrieveDraftResponsePublishWarningSeverity = "destructive"

StepIDs []string

The steps involved; empty for a sequence-wide change.

Reviewers []SequenceRetrieveDraftResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceRetrieveDraftResponseSender

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

SequenceID string

The sequence this draft belongs to.

UpdatedAt string

When the draft last changed.

Version string

Opaque token for the current state of the draft. Send it as expectedVersion on the next save, publish or discard; it changes whenever anyone edits the draft.

type SequenceRetrieveEnrollmentResponse struct{…}

ID string

Unique identifier of the enrollment.

CancelledAt string

When the enrollment was cancelled, or null if it was not.

CompletedAt string

When the enrollment completed, or null if it has not.

ContactID string

ID of the enrolled contact.

CurrentStepID string

ID of the step the contact is on, matching definition.steps; null when the contact has no current step the API returns.

EnrolledAt string

When the contact was enrolled.

EnrolledBy string

Member ID of whoever enrolled the contact; null when they are no longer a member or the enrollment was automatic.

LastActivityAt string

When lastActivityKind happened; null when there has been no activity.

LastActivityKind SequenceRetrieveEnrollmentResponseLastActivityKind

The latest activity on the enrollment. A reply or bounce that ended the enrollment is reported over a later open.

One of the following:

const SequenceRetrieveEnrollmentResponseLastActivityKindSent SequenceRetrieveEnrollmentResponseLastActivityKind = "SENT"

const SequenceRetrieveEnrollmentResponseLastActivityKindOpened SequenceRetrieveEnrollmentResponseLastActivityKind = "OPENED"

const SequenceRetrieveEnrollmentResponseLastActivityKindReplied SequenceRetrieveEnrollmentResponseLastActivityKind = "REPLIED"

const SequenceRetrieveEnrollmentResponseLastActivityKindBounced SequenceRetrieveEnrollmentResponseLastActivityKind = "BOUNCED"

const SequenceRetrieveEnrollmentResponseLastActivityKindInvited SequenceRetrieveEnrollmentResponseLastActivityKind = "INVITED"

const SequenceRetrieveEnrollmentResponseLastActivityKindConnected SequenceRetrieveEnrollmentResponseLastActivityKind = "CONNECTED"

const SequenceRetrieveEnrollmentResponseLastActivityKindSeen SequenceRetrieveEnrollmentResponseLastActivityKind = "SEEN"

NextSendAt string

RemainingSends int64

Email and LinkedIn steps not yet sent, connection requests included.

minimum-9007199254740991

maximum9007199254740991

RepliedAt string

When the contact first replied, on email or LinkedIn; null if they have not.

Status SequenceRetrieveEnrollmentResponseStatus

One of the following:

const SequenceRetrieveEnrollmentResponseStatusActive SequenceRetrieveEnrollmentResponseStatus = "ACTIVE"

const SequenceRetrieveEnrollmentResponseStatusAwaitingReview SequenceRetrieveEnrollmentResponseStatus = "AWAITING_REVIEW"

const SequenceRetrieveEnrollmentResponseStatusNeedsAttention SequenceRetrieveEnrollmentResponseStatus = "NEEDS_ATTENTION"

const SequenceRetrieveEnrollmentResponseStatusReplied SequenceRetrieveEnrollmentResponseStatus = "REPLIED"

const SequenceRetrieveEnrollmentResponseStatusCompleted SequenceRetrieveEnrollmentResponseStatus = "COMPLETED"

const SequenceRetrieveEnrollmentResponseStatusPaused SequenceRetrieveEnrollmentResponseStatus = "PAUSED"

const SequenceRetrieveEnrollmentResponseStatusCancelled SequenceRetrieveEnrollmentResponseStatus = "CANCELLED"

const SequenceRetrieveEnrollmentResponseStatusFailed SequenceRetrieveEnrollmentResponseStatus = "FAILED"

type SequenceRetrieveMessageResponseUnion interface{…}

One of the following:

type SequenceRetrieveMessageResponseOutboundMessage struct{…}

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 string

Channel the message went over.

One of the following:

const SequenceRetrieveMessageResponseOutboundMessageChannelEmail SequenceRetrieveMessageResponseOutboundMessageChannel = "EMAIL"

const SequenceRetrieveMessageResponseOutboundMessageChannelLinkedin SequenceRetrieveMessageResponseOutboundMessageChannel = "LINKEDIN"

ContactID string

ID of the contact.

Content SequenceRetrieveMessageResponseOutboundMessageContent

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 string

Always 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 SequenceRetrieveMessageResponseOutboundMessageReferenceUnion

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.

One of the following:

type SequenceRetrieveMessageResponseOutboundMessageReferenceEmail struct{…}

ID string

ID of the email.

ObjectType string

Always email.

type SequenceRetrieveMessageResponseOutboundMessageReferenceMessage struct{…}

ID string

ID of the message.

ObjectType string

Always 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 string

Type of that step.

One of the following:

const SequenceRetrieveMessageResponseOutboundMessageSequenceStepTypeEmail SequenceRetrieveMessageResponseOutboundMessageSequenceStepType = "EMAIL"

const SequenceRetrieveMessageResponseOutboundMessageSequenceStepTypeLinkedinMessage SequenceRetrieveMessageResponseOutboundMessageSequenceStepType = "LINKEDIN_MESSAGE"

const SequenceRetrieveMessageResponseOutboundMessageSequenceStepTypeLinkedinInvite SequenceRetrieveMessageResponseOutboundMessageSequenceStepType = "LINKEDIN_INVITE"

Status string

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.

One of the following:

const SequenceRetrieveMessageResponseOutboundMessageStatusAwaitingReview SequenceRetrieveMessageResponseOutboundMessageStatus = "AWAITING_REVIEW"

const SequenceRetrieveMessageResponseOutboundMessageStatusScheduled SequenceRetrieveMessageResponseOutboundMessageStatus = "SCHEDULED"

const SequenceRetrieveMessageResponseOutboundMessageStatusQueued SequenceRetrieveMessageResponseOutboundMessageStatus = "QUEUED"

const SequenceRetrieveMessageResponseOutboundMessageStatusSent SequenceRetrieveMessageResponseOutboundMessageStatus = "SENT"

const SequenceRetrieveMessageResponseOutboundMessageStatusSkipped SequenceRetrieveMessageResponseOutboundMessageStatus = "SKIPPED"

const SequenceRetrieveMessageResponseOutboundMessageStatusFailed SequenceRetrieveMessageResponseOutboundMessageStatus = "FAILED"

const SequenceRetrieveMessageResponseOutboundMessageStatusCancelled SequenceRetrieveMessageResponseOutboundMessageStatus = "CANCELLED"

StatusChangedAt string

When status last changed.

type SequenceRetrieveMessageResponseReply struct{…}

ID string

Unique identifier of the message.

Channel string

Channel the message went over.

One of the following:

const SequenceRetrieveMessageResponseReplyChannelEmail SequenceRetrieveMessageResponseReplyChannel = "EMAIL"

const SequenceRetrieveMessageResponseReplyChannelLinkedin SequenceRetrieveMessageResponseReplyChannel = "LINKEDIN"

ContactID string

ID of the contact.

Content SequenceRetrieveMessageResponseReplyContent

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 string

Always INBOUND.

EnrollmentID string

ID of the enrollment the message belongs to.

ReceivedAt string

When the reply was received.

Reference SequenceRetrieveMessageResponseReplyReferenceUnion

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.

One of the following:

type SequenceRetrieveMessageResponseReplyReferenceEmail struct{…}

ID string

ID of the email.

ObjectType string

Always email.

type SequenceRetrieveMessageResponseReplyReferenceMessage struct{…}

ID string

ID of the message.

ObjectType string

Always message.

SequenceStepID string

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

SequenceStepType string

Type of that step.

One of the following:

const SequenceRetrieveMessageResponseReplySequenceStepTypeEmail SequenceRetrieveMessageResponseReplySequenceStepType = "EMAIL"

const SequenceRetrieveMessageResponseReplySequenceStepTypeLinkedinMessage SequenceRetrieveMessageResponseReplySequenceStepType = "LINKEDIN_MESSAGE"

const SequenceRetrieveMessageResponseReplySequenceStepTypeLinkedinInvite SequenceRetrieveMessageResponseReplySequenceStepType = "LINKEDIN_INVITE"

type SequenceRetrievePerformanceResponse struct{…}

ByStepType SequenceRetrievePerformanceResponseByStepType

Lifetime totals for each step type, across all of its steps.

Email SequenceRetrievePerformanceResponseByStepTypeEmail

Email steps.

Bounced int64

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

BounceRate float64

Bounced divided by sent; null if none sent.

CurrentEnrollments int64

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Delivered int64

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

Opened int64

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

OpenRate float64

Opened divided by delivered; null if none delivered.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by delivered; null if none delivered.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceRetrievePerformanceResponseByStepTypeLinkedinInvite

LinkedIn connection request steps.

AcceptanceRate float64

Accepted divided by sent; null if none sent.

Accepted int64

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

CurrentEnrollments int64

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceRetrievePerformanceResponseByStepTypeLinkedinMessage

LinkedIn message steps.

CurrentEnrollments int64

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Read int64

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

ReadRate float64

Read divided by sent; null if none sent.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

Wait SequenceRetrievePerformanceResponseByStepTypeWait

Wait steps.

CurrentEnrollments int64

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

WaitForConnection SequenceRetrievePerformanceResponseByStepTypeWaitForConnection

Wait-for-connection steps.

CurrentEnrollments int64

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

PerStep []SequenceRetrievePerformanceResponsePerStepUnion

Per-step statistics in published sequence order, including steps with no activity. Steps no longer in the published definition are included if they have sent messages.

One of the following:

type SequenceRetrievePerformanceResponsePerStepEmailStep struct{…}

Bounced int64

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

BounceRate float64

Bounced divided by sent; null if none sent.

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Delivered int64

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

Opened int64

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

OpenRate float64

Opened divided by delivered; null if none delivered.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by delivered; null if none delivered.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

ID of the step. A step no longer in the published definition keeps its original ID.

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepLinkedInMessageStep struct{…}

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Read int64

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

ReadRate float64

Read divided by sent; null if none sent.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

ID of the step. A step no longer in the published definition keeps its original ID.

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepLinkedInInviteStep struct{…}

AcceptanceRate float64

Accepted divided by sent; null if none sent.

Accepted int64

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

ID of the step. A step no longer in the published definition keeps its original ID.

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepWaitStep struct{…}

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

ID of the step. A step no longer in the published definition keeps its original ID.

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepWaitForConnectionStep struct{…}

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

ID of the step. A step no longer in the published definition keeps its original ID.

SequenceStepType string

type SequenceRetrieveResponse struct{…}

ID string

Unique identifier of the sequence.

Channels []string

Channels the published steps send on; empty before the first publish.

One of the following:

const SequenceRetrieveResponseChannelEmail SequenceRetrieveResponseChannel = "EMAIL"

const SequenceRetrieveResponseChannelLinkedin SequenceRetrieveResponseChannel = "LINKEDIN"

CreatedAt string

ISO 8601 creation timestamp.

Definition SequenceRetrieveResponseDefinition

Published configuration, or null before the first publish.

Description string

What this version of the sequence is for.

Messaging SequenceRetrieveResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceRetrieveResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceRetrieveResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceRetrieveResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceRetrieveResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceRetrieveResponseDefinitionPriorityHigh SequenceRetrieveResponseDefinitionPriority = "HIGH"

const SequenceRetrieveResponseDefinitionPriorityNormal SequenceRetrieveResponseDefinitionPriority = "NORMAL"

SendWindow SequenceRetrieveResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceRetrieveResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceRetrieveResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveResponseDefinitionStepObjectDeliveryModeAuto SequenceRetrieveResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceRetrieveResponseDefinitionStepObjectDeliveryModeForReview SequenceRetrieveResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceRetrieveResponseDefinitionStepObjectTypeEmail SequenceRetrieveResponseDefinitionStepObjectType = "EMAIL"

const SequenceRetrieveResponseDefinitionStepObjectTypeLinkedinMessage SequenceRetrieveResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceRetrieveResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject2DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceRetrieveResponseDefinitionStepObject2DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceRetrieveResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject3DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceRetrieveResponseDefinitionStepObject3DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceRetrieveResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject4DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceRetrieveResponseDefinitionStepObject4DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceRetrieveResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject5DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceRetrieveResponseDefinitionStepObject5DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceRetrieveResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceRetrieveResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject6TypeWait SequenceRetrieveResponseDefinitionStepObject6Type = "WAIT"

const SequenceRetrieveResponseDefinitionStepObject6TypeWaitForConnection SequenceRetrieveResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceRetrieveResponseDefinitionStepObject6UnitDay SequenceRetrieveResponseDefinitionStepObject6Unit = "DAY"

const SequenceRetrieveResponseDefinitionStepObject6UnitMinute SequenceRetrieveResponseDefinitionStepObject6Unit = "MINUTE"

FirstActivatedAt string

When the sequence was first activated.

LastActivatedAt string

When the sequence was most recently activated.

Name string

Name of the sequence.

ObjectType SequenceRetrieveResponseObjectType

Always sequence.

Reviewers []SequenceRetrieveResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceRetrieveResponseSender

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

Status SequenceRetrieveResponseStatus

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

const SequenceRetrieveResponseStatusDraft SequenceRetrieveResponseStatus = "DRAFT"

const SequenceRetrieveResponseStatusActive SequenceRetrieveResponseStatus = "ACTIVE"

const SequenceRetrieveResponseStatusDeactivated SequenceRetrieveResponseStatus = "DEACTIVATED"

type SequenceRetrieveTestResponse struct{…}

ID string

ID of the test, an enrollment ID.

ContactID string

ID of the contact tested.

Status SequenceRetrieveTestResponseStatus

RUNNING until every step has finished, then COMPLETED, or FAILED when the test ended on a failure.

One of the following:

const SequenceRetrieveTestResponseStatusRunning SequenceRetrieveTestResponseStatus = "RUNNING"

const SequenceRetrieveTestResponseStatusCompleted SequenceRetrieveTestResponseStatus = "COMPLETED"

const SequenceRetrieveTestResponseStatusFailed SequenceRetrieveTestResponseStatus = "FAILED"

Steps []SequenceRetrieveTestResponseStep

Every step of the tested version that the Sequences API lists, in run order. Call steps are not part of the API yet, so a test reports nothing for them.

Error SequenceRetrieveTestResponseStepError

Why the step failed; null unless outcome is FAILED.

Code string

CONFIGURATION_ERROR when the sequence or the contact needs a change, SYSTEM_ERROR when Lightfield failed.

One of the following:

const SequenceRetrieveTestResponseStepErrorCodeConfigurationError SequenceRetrieveTestResponseStepErrorCode = "CONFIGURATION_ERROR"

const SequenceRetrieveTestResponseStepErrorCodeSystemError SequenceRetrieveTestResponseStepErrorCode = "SYSTEM_ERROR"

Message string

What went wrong, in plain words.

Message SequenceRetrieveTestResponseStepMessageUnion

The composed message; null when the step has not composed one.

One of the following:

type SequenceRetrieveTestResponseStepMessageEmailMessage struct{…}

Body string

Body as markdown, the same form a template step reads back in.

Subject string

Subject line, as composed.

type SequenceRetrieveTestResponseStepMessageLinkedInMessage struct{…}

Body string

Message text, as composed.

Mode string

How a send step’s content is composed; null for a wait step.

One of the following:

const SequenceRetrieveTestResponseStepModeAgent SequenceRetrieveTestResponseStepMode = "AGENT"

const SequenceRetrieveTestResponseStepModeTemplate SequenceRetrieveTestResponseStepMode = "TEMPLATE"

Name string

Name of the step, as in definition.steps; null for a wait step.

Outcome string

PENDING while the step has not run, including a step a finished test never reached, COMPOSED when it produced a message, SKIPPED when it produced nothing: a test never waits, so a wait is always SKIPPED, and a send step is SKIPPED when it has nothing to send, such as a LinkedIn invite another step already sent. FAILED when it failed: see error.

One of the following:

const SequenceRetrieveTestResponseStepOutcomePending SequenceRetrieveTestResponseStepOutcome = "PENDING"

const SequenceRetrieveTestResponseStepOutcomeComposed SequenceRetrieveTestResponseStepOutcome = "COMPOSED"

const SequenceRetrieveTestResponseStepOutcomeSkipped SequenceRetrieveTestResponseStepOutcome = "SKIPPED"

const SequenceRetrieveTestResponseStepOutcomeFailed SequenceRetrieveTestResponseStepOutcome = "FAILED"

StepID string

ID of the step, as in the sequence’s definition.steps.

Type string

Step type.

One of the following:

const SequenceRetrieveTestResponseStepTypeEmail SequenceRetrieveTestResponseStepType = "EMAIL"

const SequenceRetrieveTestResponseStepTypeLinkedinMessage SequenceRetrieveTestResponseStepType = "LINKEDIN_MESSAGE"

const SequenceRetrieveTestResponseStepTypeLinkedinInvite SequenceRetrieveTestResponseStepType = "LINKEDIN_INVITE"

const SequenceRetrieveTestResponseStepTypeWait SequenceRetrieveTestResponseStepType = "WAIT"

const SequenceRetrieveTestResponseStepTypeWaitForConnection SequenceRetrieveTestResponseStepType = "WAIT_FOR_CONNECTION"

Target SequenceRetrieveTestResponseTarget

Which version was tested.

One of the following:

const SequenceRetrieveTestResponseTargetDraft SequenceRetrieveTestResponseTarget = "DRAFT"

const SequenceRetrieveTestResponseTargetPublished SequenceRetrieveTestResponseTarget = "PUBLISHED"

type SequenceStartTestResponse struct{…}

ID string

ID of the test, an enrollment ID. Use it to read the result.

ContactID string

ID of the contact being tested.

Status SequenceStartTestResponseStatus

Always RUNNING: the test continues after the response.

Target SequenceStartTestResponseTarget

Which version is being tested: the open DRAFT when there is one or the sequence was never published, otherwise the PUBLISHED version.

One of the following:

const SequenceStartTestResponseTargetDraft SequenceStartTestResponseTarget = "DRAFT"

const SequenceStartTestResponseTargetPublished SequenceStartTestResponseTarget = "PUBLISHED"

type SequenceUpdateDraftResponse struct{…}

Channels []string

Channels the draft’s steps send on.

One of the following:

const SequenceUpdateDraftResponseChannelEmail SequenceUpdateDraftResponseChannel = "EMAIL"

const SequenceUpdateDraftResponseChannelLinkedin SequenceUpdateDraftResponseChannel = "LINKEDIN"

Definition SequenceUpdateDraftResponseDefinition

The draft configuration, in the same shape as a published definition.

Description string

What this version of the sequence is for.

Messaging SequenceUpdateDraftResponseDefinitionMessaging

Messaging inputs that frame every step.

CallToAction string

What the recipient is asked to do.

Persona string

Who the sequence targets.

Trigger string

Why the outreach is timely.

ValueProp string

The value proposition.

Pacing SequenceUpdateDraftResponseDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

Email SequenceUpdateDraftResponseDefinitionPacingEmail

Email steps.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceUpdateDraftResponseDefinitionPacingLinkedinInvite

LinkedIn connection requests.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceUpdateDraftResponseDefinitionPacingLinkedinMessage

LinkedIn messages.

DailyLimit int64

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

Priority string

Send priority relative to other sequences.

One of the following:

const SequenceUpdateDraftResponseDefinitionPriorityHigh SequenceUpdateDraftResponseDefinitionPriority = "HIGH"

const SequenceUpdateDraftResponseDefinitionPriorityNormal SequenceUpdateDraftResponseDefinitionPriority = "NORMAL"

SendWindow SequenceUpdateDraftResponseDefinitionSendWindow

When the sequence may send.

DaysOfWeek []int64

Days sends may go out, 0 = Sunday.

EndHour int64

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

StartHour int64

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

Timezone string

IANA timezone of the window.

Steps []SequenceUpdateDraftResponseDefinitionStepUnion

Email, LinkedIn and wait steps in execution order.

One of the following:

type SequenceUpdateDraftResponseDefinitionStepObject struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObjectDeliveryModeAuto SequenceUpdateDraftResponseDefinitionStepObjectDeliveryMode = "AUTO"

const SequenceUpdateDraftResponseDefinitionStepObjectDeliveryModeForReview SequenceUpdateDraftResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObjectTypeEmail SequenceUpdateDraftResponseDefinitionStepObjectType = "EMAIL"

const SequenceUpdateDraftResponseDefinitionStepObjectTypeLinkedinMessage SequenceUpdateDraftResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"

type SequenceUpdateDraftResponseDefinitionStepObject2 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject2DeliveryModeAuto SequenceUpdateDraftResponseDefinitionStepObject2DeliveryMode = "AUTO"

const SequenceUpdateDraftResponseDefinitionStepObject2DeliveryModeForReview SequenceUpdateDraftResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Prompt string

Instructions the agent follows when composing this message.

Type string

Step type.

type SequenceUpdateDraftResponseDefinitionStepObject3 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject3DeliveryModeAuto SequenceUpdateDraftResponseDefinitionStepObject3DeliveryMode = "AUTO"

const SequenceUpdateDraftResponseDefinitionStepObject3DeliveryModeForReview SequenceUpdateDraftResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceUpdateDraftResponseDefinitionStepObject3Template

The email every contact receives.

Body string

Subject string

Type string

Step type.

type SequenceUpdateDraftResponseDefinitionStepObject4 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject4DeliveryModeAuto SequenceUpdateDraftResponseDefinitionStepObject4DeliveryMode = "AUTO"

const SequenceUpdateDraftResponseDefinitionStepObject4DeliveryModeForReview SequenceUpdateDraftResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceUpdateDraftResponseDefinitionStepObject4Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceUpdateDraftResponseDefinitionStepObject5 struct{…}

ID string

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

DeliveryMode string

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject5DeliveryModeAuto SequenceUpdateDraftResponseDefinitionStepObject5DeliveryMode = "AUTO"

const SequenceUpdateDraftResponseDefinitionStepObject5DeliveryModeForReview SequenceUpdateDraftResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"

IncludeNote bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

Mode string

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Name string

Display name of the step.

Template SequenceUpdateDraftResponseDefinitionStepObject5Template

The message every contact receives; for an invite, its connection note, sent only with includeNote.

Body string

Type string

Step type.

type SequenceUpdateDraftResponseDefinitionStepObject6 struct{…}

ID string

Step identifier.

Duration int64

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

Type string

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject6TypeWait SequenceUpdateDraftResponseDefinitionStepObject6Type = "WAIT"

const SequenceUpdateDraftResponseDefinitionStepObject6TypeWaitForConnection SequenceUpdateDraftResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"

Unit string

Unit of duration.

One of the following:

const SequenceUpdateDraftResponseDefinitionStepObject6UnitDay SequenceUpdateDraftResponseDefinitionStepObject6Unit = "DAY"

const SequenceUpdateDraftResponseDefinitionStepObject6UnitMinute SequenceUpdateDraftResponseDefinitionStepObject6Unit = "MINUTE"

Name string

Name the sequence takes when the draft is published.

PublishWarnings []SequenceUpdateDraftResponsePublishWarning

Code string

What publishing would change.

One of the following:

const SequenceUpdateDraftResponsePublishWarningCodeDelayShortened SequenceUpdateDraftResponsePublishWarningCode = "delay_shortened"

const SequenceUpdateDraftResponsePublishWarningCodeDelayLengthened SequenceUpdateDraftResponsePublishWarningCode = "delay_lengthened"

const SequenceUpdateDraftResponsePublishWarningCodeConnectionWaitShortened SequenceUpdateDraftResponsePublishWarningCode = "connection_wait_shortened"

const SequenceUpdateDraftResponsePublishWarningCodeConnectionWaitLengthened SequenceUpdateDraftResponsePublishWarningCode = "connection_wait_lengthened"

const SequenceUpdateDraftResponsePublishWarningCodeSendScheduleChanged SequenceUpdateDraftResponsePublishWarningCode = "send_schedule_changed"

const SequenceUpdateDraftResponsePublishWarningCodeSendConfigurationChanged SequenceUpdateDraftResponsePublishWarningCode = "send_configuration_changed"

const SequenceUpdateDraftResponsePublishWarningCodeSendPriorityChanged SequenceUpdateDraftResponsePublishWarningCode = "send_priority_changed"

const SequenceUpdateDraftResponsePublishWarningCodeSendersChanged SequenceUpdateDraftResponsePublishWarningCode = "senders_changed"

const SequenceUpdateDraftResponsePublishWarningCodeEmailSenderPoolEmptied SequenceUpdateDraftResponsePublishWarningCode = "email_sender_pool_emptied"

const SequenceUpdateDraftResponsePublishWarningCodeLinkedinAccountPoolEmptied SequenceUpdateDraftResponsePublishWarningCode = "linkedin_account_pool_emptied"

const SequenceUpdateDraftResponsePublishWarningCodeAssignedSenderRemoved SequenceUpdateDraftResponsePublishWarningCode = "assigned_sender_removed"

const SequenceUpdateDraftResponsePublishWarningCodeDeliveryBecameAutomatic SequenceUpdateDraftResponsePublishWarningCode = "delivery_became_automatic"

const SequenceUpdateDraftResponsePublishWarningCodeInviteNoteEnabled SequenceUpdateDraftResponsePublishWarningCode = "invite_note_enabled"

const SequenceUpdateDraftResponsePublishWarningCodeInviteNoteDisabled SequenceUpdateDraftResponsePublishWarningCode = "invite_note_disabled"

const SequenceUpdateDraftResponsePublishWarningCodeStepInserted SequenceUpdateDraftResponsePublishWarningCode = "step_inserted"

const SequenceUpdateDraftResponsePublishWarningCodeAutomaticSendStepInserted SequenceUpdateDraftResponsePublishWarningCode = "automatic_send_step_inserted"

const SequenceUpdateDraftResponsePublishWarningCodeStepRemoved SequenceUpdateDraftResponsePublishWarningCode = "step_removed"

const SequenceUpdateDraftResponsePublishWarningCodeStepTypeChanged SequenceUpdateDraftResponsePublishWarningCode = "step_type_changed"

const SequenceUpdateDraftResponsePublishWarningCodeStepOrderChanged SequenceUpdateDraftResponsePublishWarningCode = "step_order_changed"

const SequenceUpdateDraftResponsePublishWarningCodeFullIdentityRewrite SequenceUpdateDraftResponsePublishWarningCode = "full_identity_rewrite"

const SequenceUpdateDraftResponsePublishWarningCodeLowIdentityOverlap SequenceUpdateDraftResponsePublishWarningCode = "low_identity_overlap"

Message string

What would change, in plain language.

Severity string

destructive when contacts already in the sequence may skip, repeat or receive a step they would not have; warning otherwise.

One of the following:

const SequenceUpdateDraftResponsePublishWarningSeverityWarning SequenceUpdateDraftResponsePublishWarningSeverity = "warning"

const SequenceUpdateDraftResponsePublishWarningSeverityDestructive SequenceUpdateDraftResponsePublishWarningSeverity = "destructive"

StepIDs []string

The steps involved; empty for a sequence-wide change.

Reviewers []SequenceUpdateDraftResponseReviewer

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

ID string

ID of the member.

minLength1

ObjectType string

Always member.

Senders []SequenceUpdateDraftResponseSender

ID string

ID of the sender.

minLength1

ObjectType string

Always sender.

SequenceID string

The sequence this draft belongs to.

UpdatedAt string

When the draft last changed.

Version string

Opaque token for the current state of the draft. Send it as expectedVersion on the next save, publish or discard; it changes whenever anyone edits the draft.

type SequenceUpdateEnrollmentsResponse struct{…}

Results []SequenceUpdateEnrollmentsResponseResultUnion

One result per distinct contact, additions first, then removals.

One of the following:

type SequenceUpdateEnrollmentsResponseResultEnrollmentChanged struct{…}

ContactID string

ID of the contact.

EnrollmentID string

ID of the enrollment the outcome applies to.

Outcome string

enrolled created the enrollment, already_enrolled left an open one as is, unenrolled cancelled it.

One of the following:

const SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcomeEnrolled SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcome = "enrolled"

const SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcomeAlreadyEnrolled SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcome = "already_enrolled"

const SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcomeUnenrolled SequenceUpdateEnrollmentsResponseResultEnrollmentChangedOutcome = "unenrolled"

type SequenceUpdateEnrollmentsResponseResultNothingToCancel struct{…}

ContactID string

ID of the contact.

EnrollmentID any

Always null.

Outcome string

The contact had no open enrollment to cancel.