Skip to Content
Outreach

Update sending settings

Change one Gmail mailbox's daily send cap or switch its sending on or off.

PATCHhttps://api.rankparse.com/v1/outreach/sendingFreeAPI key

Changes the settings of one mailbox: the default unless you pass mailbox_id. Each mailbox has its own cap and switch, shared by every campaign that sends from it. Stopping (a lower cap, or turning sending off) always applies at once. Raising the cap or turning sending on is held for a person's approval when an agent asks in an account where the approval inbox is enforced.

Body parameters

mailbox_idstring

A mailbox_id from Get sending settings. Omit it for the default mailbox. A value that is not a non-empty string returns 400 invalid_mailbox_id; an id outside your workspace returns 404 mailbox_not_found.

max_sends_per_dayinteger

1 to 100. Otherwise 400 invalid_send_cap. A plan cap, when one applies, still limits what is actually sent.

auto_send_enabledboolean

false stops all sending from the mailbox, true resumes it. Not a boolean returns 400 invalid_auto_send.

agent_autosendboolean

Only false is accepted: it turns off Let Claude send without review for the mailbox. Only a person can turn it on, in RankParse; true returns 403 human_only_setting.

Send at least one of max_sends_per_day and auto_send_enabled (or agent_autosend: false), otherwise 400 nothing_to_update. Every field is validated before anything is written, so a 400 means nothing changed. Other keys are ignored.

Response

A change that applies directly returns 200:

okboolean

true.

An agent call (MCP, or the header X-RankParse-Client: mcp) that raises the cap or turns sending on, in an account where the approval inbox is enforced, returns 202 and changes nothing yet except any stopping part of the same request:

statusstring

awaiting_approval, or approved when the same change was already approved and is running.

proposal_idstring

The outreach_sending_change proposal. See Proposals.

review_urlstring

Where the user approves it. Show it to them.

appliedobject

Present when the request mixed a stop and an increase: the fields that took effect now (for example { "auto_send_enabled": false } or a lower max_sends_per_day). The message then starts with "Applied now:".

messagestring

Plain-text guidance to relay to the user.

A new increase for the same mailbox replaces a pending one (the old proposal becomes superseded). A sending-change proposal expires after 3 days.

Errors

HTTPCodeWhen
400invalid_jsonThe body is not valid JSON.
400invalid_mailbox_idmailbox_id is not a non-empty string.
400invalid_send_capmax_sends_per_day is not an integer from 1 to 100.
400invalid_auto_sendauto_send_enabled is not a boolean.
400nothing_to_updateNo field to change.
400gmail_not_connectedThere is no mailbox to change, or (agent increase) Google stopped accepting it and it needs reconnecting.
403capability_missingYour role cannot manage outreach.
403human_only_settingagent_autosend was not false.
403action_disabled_by_policyAgent increase: the owner turned this action Off.
404mailbox_not_foundmailbox_id is not a mailbox of your workspace.
409change_in_progressAgent increase: a different sending change for this mailbox is already approved and running. The increase was not applied; any stopping part was. Try again after it completes.
429too_many_pending_proposals, daily_proposal_limit_reachedAgent increase: the proposal limits.

Plus the shared errors.

MCP tool: outreach_configure_sending (accepts max_sends_per_day, auto_send_enabled, mailbox_id). Confirm with the user before changing these: they control real email volume.