sender/patch_by_id

Tool: update

Update editable properties of a sender account.

Applies partial updates to an existing sender. Only supplied fields are changed. Returns the full updated sender object. See schemas/sender for all response fields.

Re-send every boolean you want to keep. Despite the only-supplied-fields rule, a boolean omitted from this patch is currently reset to false — warmup most consequentially. The rest of the write rules (clearing a field, why null fails) are shared: call-contract.

replyTo caveat: if set, Unibox will not catch replies unless the reply-to address is also connected as a sender.

Arguments

name	type	req	notes
id	integer	✓	Sender ID — the object's `senderId` (int64)

Body

All fields optional. Same field set as sender/post minus the required credentials — see that doc for field definitions. Key fields:

field	type	req	constraints	description
folder	string	–		Organizational folder
fromName	string	–		Display name in outgoing emails
replyTo	string	–		Reply-to address
firstName	string	–		Sender first name
lastName	string	–		Sender last name
signature	string	–		HTML email signature
trackingDomain	string	–		Custom domain for tracking
delayMinMinutes	integer	–		Min gap between sends from this mailbox — minutes, not seconds. The campaign-level gap is `delayMinSeconds`, in seconds
dailyLimit	integer	–	1–10000	Max emails per day
dailyLimitIncrease	boolean	–		Progressive daily limit ramp
dailyLimitIncreaseToMax	integer	–		Target max for ramp
dailyLimitIncreasePercent	integer	–	1–100	Daily % for ramp
warmup	boolean	–		Enable warmup
warmupDailyLimitIncrease	boolean	–		Progressive limit during warmup
warmupDailyLimitIncreaseToMax	integer	–	1–10000	Target max during warmup
warmupDailyLimitIncreasePercent	integer	–	1–10000	Daily % during warmup
warmupDailyLimit	integer	–		Initial warmup daily limit
warmupReplyPercent	integer	–	1–100	% of warmup emails with auto-replies
warmupSkipWeekends	boolean	–		Skip warmup on weekends
customWarmupTag	string	–	≤64 chars	Tag for warmup emails
customSmtpServer	string	–		SMTP hostname
customSmtpPort	integer	–		SMTP port
customSmtpUsername	string	–		SMTP username
customSmtpPass	string	–		SMTP password
customImapServer	string	–		IMAP hostname
customImapPort	integer	–	1–65535	IMAP port (typically 993 for SSL/TLS)
customImapUsername	string	–		IMAP username
customImapPass	string	–		IMAP password
senderCustom1–10	string	–	≤4000 chars each	Custom fields 1–10

Response

200 — Updated sender object: see schemas/sender. Deltas: none.

Errors: 400, 401, 404, 406, 415, 422, 429, 500 — shared schema: schemas/errors.

Invoke

Call update with name: "sender/patch_by_id".