Sender
Senders are the email mailboxes and LinkedIn accounts sequences send from. Creating, connecting and archiving a sender happen in the Lightfield app.
Retrieve a sender
List senders
Update a sender
Mark a sender healthy
ModelsExpand Collapse
SenderListResponse object { data, object, totalCount }
data: array of object { id, archivedAt, channel, 9 more }
When the sender was archived, or null if it is active. Archived senders never send.
The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address.
health: "UNVERIFIED" or "HEALTHY" or "UNHEALTHY"HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.
Member ID of the person who owns this sender, or null when no workspace membership can be resolved.
pacing: object { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE } How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds } Email steps. Present only on an email sender.
Email steps. Present only on an email sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn connection requests. Present only on a LinkedIn sender.
LinkedIn connection requests. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn messages. Present only on a LinkedIn sender.
LinkedIn messages. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
SenderMarkHealthyResponse object { id, archivedAt, channel, 9 more }
When the sender was archived, or null if it is active. Archived senders never send.
The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address.
health: "UNVERIFIED" or "HEALTHY" or "UNHEALTHY"HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.
Member ID of the person who owns this sender, or null when no workspace membership can be resolved.
pacing: object { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE } How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds } Email steps. Present only on an email sender.
Email steps. Present only on an email sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn connection requests. Present only on a LinkedIn sender.
LinkedIn connection requests. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn messages. Present only on a LinkedIn sender.
LinkedIn messages. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
SenderRetrieveResponse object { id, archivedAt, channel, 9 more }
When the sender was archived, or null if it is active. Archived senders never send.
The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address.
health: "UNVERIFIED" or "HEALTHY" or "UNHEALTHY"HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.
Member ID of the person who owns this sender, or null when no workspace membership can be resolved.
pacing: object { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE } How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds } Email steps. Present only on an email sender.
Email steps. Present only on an email sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn connection requests. Present only on a LinkedIn sender.
LinkedIn connection requests. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn messages. Present only on a LinkedIn sender.
LinkedIn messages. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
SenderUpdateResponse object { id, archivedAt, channel, 9 more }
When the sender was archived, or null if it is active. Archived senders never send.
The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address.
health: "UNVERIFIED" or "HEALTHY" or "UNHEALTHY"HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.
Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.
Member ID of the person who owns this sender, or null when no workspace membership can be resolved.
pacing: object { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE } How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.
EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds } Email steps. Present only on an email sender.
Email steps. Present only on an email sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn connection requests. Present only on a LinkedIn sender.
LinkedIn connection requests. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.
LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds } LinkedIn messages. Present only on a LinkedIn sender.
LinkedIn messages. Present only on a LinkedIn sender.
Most sends of this step type in any rolling 24 hours.
Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.