API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sender

The Senders API is in Preview. Endpoints, parameters, and response schemas may change, including breaking changes, as we incorporate feedback.

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

$ lightfield sender retrieve

GET/v1/senders/{id}

List senders

$ lightfield sender list

GET/v1/senders

Update a sender

$ lightfield sender update

POST/v1/senders/{id}

Mark a sender healthy

$ lightfield sender mark-healthy

POST/v1/senders/{id}/mark_healthy

ModelsExpand Collapse

sender_list_response: object { data, object, totalCount }

data: array of object { id, archivedAt, channel, 9 more }

id: string

Unique identifier of the sender.

archivedAt: string

When the sender was archived, or null if it is active. Archived senders never send.

channel: "EMAIL" or "LINKEDIN"

Whether this sender sends email or LinkedIn messages.

"EMAIL"

"LINKEDIN"

createdAt: string

When the sender was created.

emailAddress: string

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.

"UNVERIFIED"

"HEALTHY"

"UNHEALTHY"

healthReason: string

Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.

objectType: "sender"

Always sender.

"sender"

owner: string

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.

EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

Email steps. Present only on an email sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn connection requests. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn messages. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

replyToAddress: string

SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders.

transport: "SMTP" or "OAUTH"

How an email sender sends: SMTP through its own mail server, OAUTH through its connected Google or Microsoft account. Null for LinkedIn senders.

"SMTP"

"OAUTH"

object: "list"

"list"

totalCount: number

sender_mark_healthy_response: object { id, archivedAt, channel, 9 more }

id: string

Unique identifier of the sender.

archivedAt: string

When the sender was archived, or null if it is active. Archived senders never send.

channel: "EMAIL" or "LINKEDIN"

Whether this sender sends email or LinkedIn messages.

"EMAIL"

"LINKEDIN"

createdAt: string

When the sender was created.

emailAddress: string

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.

"UNVERIFIED"

"HEALTHY"

"UNHEALTHY"

healthReason: string

Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.

objectType: "sender"

Always sender.

"sender"

owner: string

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.

EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

Email steps. Present only on an email sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn connection requests. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn messages. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

replyToAddress: string

SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders.

transport: "SMTP" or "OAUTH"

How an email sender sends: SMTP through its own mail server, OAUTH through its connected Google or Microsoft account. Null for LinkedIn senders.

"SMTP"

"OAUTH"

sender_retrieve_response: object { id, archivedAt, channel, 9 more }

id: string

Unique identifier of the sender.

archivedAt: string

When the sender was archived, or null if it is active. Archived senders never send.

channel: "EMAIL" or "LINKEDIN"

Whether this sender sends email or LinkedIn messages.

"EMAIL"

"LINKEDIN"

createdAt: string

When the sender was created.

emailAddress: string

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.

"UNVERIFIED"

"HEALTHY"

"UNHEALTHY"

healthReason: string

Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.

objectType: "sender"

Always sender.

"sender"

owner: string

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.

EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

Email steps. Present only on an email sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn connection requests. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn messages. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

replyToAddress: string

SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders.

transport: "SMTP" or "OAUTH"

How an email sender sends: SMTP through its own mail server, OAUTH through its connected Google or Microsoft account. Null for LinkedIn senders.

"SMTP"

"OAUTH"

sender_update_response: object { id, archivedAt, channel, 9 more }

id: string

Unique identifier of the sender.

archivedAt: string

When the sender was archived, or null if it is active. Archived senders never send.

channel: "EMAIL" or "LINKEDIN"

Whether this sender sends email or LinkedIn messages.

"EMAIL"

"LINKEDIN"

createdAt: string

When the sender was created.

emailAddress: string

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.

"UNVERIFIED"

"HEALTHY"

"UNHEALTHY"

healthReason: string

Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.

objectType: "sender"

Always sender.

"sender"

owner: string

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.

EMAIL: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

Email steps. Present only on an email sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_INVITE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn connection requests. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

LINKEDIN_MESSAGE: optional object { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn messages. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

maxGapSeconds: number

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.

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

replyToAddress: string

SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders.

transport: "SMTP" or "OAUTH"

How an email sender sends: SMTP through its own mail server, OAUTH through its connected Google or Microsoft account. Null for LinkedIn senders.

"SMTP"

"OAUTH"