Skip to Content
RankParseDocs
ChangelogDashboardGet API key
DocumentationAPI Reference
Outreach

Get sending settings

Read a Gmail mailbox's sending status, daily cap and queue, plus every mailbox of the workspace.

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

Returns the sending status of one mailbox (the workspace's default unless you name another) and a mailboxes list with every connected Gmail account. Use it to explain why queued emails are or are not going out. See Mailboxes and sending for how a campaign picks its mailbox.

Query parameters

mailbox_idstring

A mailbox_id from the mailboxes list. Omit it for the default mailbox. An id that is not a mailbox of your workspace returns 404 mailbox_not_found.

Response

The top-level fields describe the selected mailbox.

connectedboolean

true when the mailbox can send. false when there is no mailbox, it was disconnected, or Google stopped accepting it. A not-connected answer carries a message (with where to connect) instead of the counters below, plus mailbox_id, gmail_email and, for a broken connection, needs_reconnect: true.

mailbox_idstring

The selected mailbox.

gmail_emailstring

Its Gmail address.

auto_send_enabledboolean

The mailbox's on/off switch. When false, nothing it holds is sent.

max_sends_per_dayinteger

Its daily cap (1 to 100), lowered to the plan's cap when one applies (5 a day on the Free plan when plan limits are enforced).

sent_todayinteger

Emails sent today (UTC day).

remaining_todayinteger

max_sends_per_day minus sent_today, never below 0.

queued_across_campaignsinteger

Emails queued to send from this mailbox, across its campaigns that are not paused.

estimated_days_to_draininteger | null

queued_across_campaigns divided by the daily cap, rounded up.

mailboxesarray

Every mailbox of the workspace, default first. Empty when no Gmail is connected.

Show properties
mailbox_idstring

Use it as mailbox_id here and in Update sending settings.

gmail_emailstring

Gmail address.

is_defaultboolean

true for the workspace default.

connectedboolean

Connected and working.

needs_reconnectboolean

Connected, but Google stopped accepting it. The user must reconnect it.

auto_send_enabledboolean

On/off switch.

max_sends_per_dayinteger

Daily cap, after the plan's cap.

sent_todayinteger

Sent today. Also remaining_today.

queuedinteger

Emails queued on this mailbox.

estimated_days_to_draininteger | null

Days to send them at the current cap.

Errors

HTTPCodeWhen
403capability_missingYour role cannot view outreach.
404mailbox_not_foundmailbox_id is not a mailbox of your workspace.

Plus the shared errors.

MCP tool: outreach_sending_status (accepts mailbox_id).

Update sending settings

Change a mailbox's cap or switch.

Outreach guide

Connect Gmail and set sending limits.

Resume a campaign

Let a paused campaign's queued emails send again.

Update sending settings

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