Campaigns

List campaigns

Returns campaigns with summary stats (sent/opened/replied/...). Cursor paginated. Email and multichannel campaigns also carry sendingMailboxes (the mailboxes each one sends from — state is ready, sending_paused or needs_reconnect; campaignDailyLimit is the most the campaign sends from that mailbox per day; up to 50 per campaign), the exact sendingMailboxCount and sendingMailboxStateCounts (how many of them are in each state). All three are null for other channels.

Required scope: campaigns:read.

Returns a cursor-paginated list — pass cursor from the previous page to continue.

get/campaigns

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/campaigns
  • Auth: HTTP bearer

Query parameters

limitinteger

Results per page (1–100).

cursorstring

next_cursor from the previous page.

status'draft' | 'scheduled' | 'running' | 'paused' | 'completed' | 'error'

Filter by status.

archived'true' | 'false'

true lists only archived campaigns (hidden from the default list). Restore one with POST /campaigns/{id}/unarchive.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.