## Update a sender `client.sender.update(stringid, SenderUpdateParamsbody, RequestOptionsoptions?): SenderUpdateResponse` **post** `/v1/senders/{id}` Replaces a sender's pacing and returns the updated sender. Send exactly the sender's step types, with every value: read the sender first to change only some of them. Concurrent updates are last-write-wins. Each step type must stay within the ceilings the workspace's own limits have, and `maxGapSeconds` can't be below `minGapSeconds`: `EMAIL` on an OAuth sender `dailyLimit` at least 1 and gaps 60 to 3600 seconds; `EMAIL` on an SMTP sender `dailyLimit` 1 to 100 and gaps 60 to 3600 seconds; `LINKEDIN_INVITE` `dailyLimit` 1 to 30 and gaps 120 to 3600 seconds; `LINKEDIN_MESSAGE` `dailyLimit` 1 to 60 and gaps 120 to 3600 seconds. Out-of-range values, or step types the sender doesn't send, return 400. Returns 409 if the sender is archived; archived senders can be read but not updated. **[Required scope](/using-the-api/scopes/):** `senders:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: string` Unique identifier of the sender to update. - `body: SenderUpdateParams` - `pacing: Pacing` The sender's new pacing, replacing all of its current values. Send exactly the step types the sender's channel sends: `EMAIL` for an email sender; `LINKEDIN_INVITE` and `LINKEDIN_MESSAGE` for a LinkedIn sender. - `EMAIL?: Email` Email steps. Present only on an email sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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?: LinkedinInvite` LinkedIn connection requests. Present only on a LinkedIn sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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?: LinkedinMessage` LinkedIn messages. Present only on a LinkedIn sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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. ### Returns - `SenderUpdateResponse` - `id: string` Unique identifier of the sender. - `archivedAt: string | null` When the sender was archived, or null if it is active. Archived senders never send. - `channel: "EMAIL" | "LINKEDIN"` Whether this sender sends email or LinkedIn messages. - `"EMAIL"` - `"LINKEDIN"` - `createdAt: string` When the sender was created. - `emailAddress: string | null` The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address. - `health: "UNVERIFIED" | "HEALTHY" | "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 | null` 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 | null` Member ID of the person who owns this sender, or null when no workspace membership can be resolved. - `pacing: Pacing` 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?: Email` Email steps. Present only on an email sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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?: LinkedinInvite` LinkedIn connection requests. Present only on a LinkedIn sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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?: LinkedinMessage` LinkedIn messages. Present only on a LinkedIn sender. - `dailyLimit: number` Most sends of this step type in any rolling 24 hours. - `maxGapSeconds: number | null` 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 | null` SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders. - `transport: "SMTP" | "OAUTH" | null` 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"` ### Example ```typescript import Lightfield from 'lightfield'; const client = new Lightfield({ apiKey: 'My API Key', }); const senderUpdateResponse = await client.sender.update('id', { pacing: {} }); console.log(senderUpdateResponse.id); ``` #### Response ```json { "id": "id", "archivedAt": "archivedAt", "channel": "EMAIL", "createdAt": "createdAt", "emailAddress": "emailAddress", "health": "UNVERIFIED", "healthReason": "healthReason", "objectType": "sender", "owner": "owner", "pacing": { "EMAIL": { "dailyLimit": -9007199254740991, "maxGapSeconds": -9007199254740991, "minGapSeconds": -9007199254740991 }, "LINKEDIN_INVITE": { "dailyLimit": -9007199254740991, "maxGapSeconds": -9007199254740991, "minGapSeconds": -9007199254740991 }, "LINKEDIN_MESSAGE": { "dailyLimit": -9007199254740991, "maxGapSeconds": -9007199254740991, "minGapSeconds": -9007199254740991 } }, "replyToAddress": "replyToAddress", "transport": "SMTP" } ```