Campaigns

Create a campaign

Creates a draft. Nothing sends until you launch. Takes every setting of the update call. Defaults: 100 emails a day, 08:00 to 17:00 America/New_York, weekdays only, a pause of 60 to 120 minutes between two emails from one mailbox, plain text, no unsubscribe line.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists
post/api/v1/campaigns

Request

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

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

namestring required

Campaign name.

daily_limitinteger

Emails a day for the whole campaign (default 100).

per_mailbox_daily_limitinteger

Most emails a day from one mailbox.

max_active_mailboxesinteger

Rotate between at most this many mailboxes.

timezonestring

Time zone name, for example Europe/Berlin (default America/New_York).

timezone_mode'fixed' | 'lead'

fixed: the campaign's time zone. lead: each person's local time.

window_startstring

Sending starts, HH:MM (default 08:00).

window_endstring

Sending stops, HH:MM (default 17:00).

skip_weekendsboolean

No emails on Saturday and Sunday (default true).

gap_minutes_mininteger

Shortest pause between two emails from one mailbox (default 60).

gap_minutes_maxinteger

Longest pause (default 120).

include_unsubscribeboolean

Add an opt-out line at the bottom of every email (default false).

stop_on_replyboolean

A reply ends that person's emails (default true).

planned_start_datestring date

YYYY-MM-DD. A launch before this date waits.

tagsstring[]

Your own tags.

auto_pauseboolean

Pause by itself when bounces are high or the mailboxes are offline.

auto_pause_bounce_rate_pctnumber

Bounce share in percent that pauses, 1 to 50 (default 10).

accepted_email_gradesstring[]

Which email results may join: valid always; add catch_all, unknown or risky to accept them.

Example request

{
  "name": "Q4 CFO outreach"
}

Response

OK

nextstring

Changes

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