campaigns

Plan a dated campaign and quote its price (read-only).

Read-only capacity planner for a dated campaign (for example a fundraising drive). Nothing is booked, charged or changed. safeReach is how many contacts the warm-up ramp can safely reach if the campaign is booked on bookingDate; priceCents is for that many. A bookingDate after the last campaign day is refused 400. Campaign checkout and booking are not available: to book, contact support (contact_operator).

post/campaigns/plan

Request

  • Base URL: https://api.coldrig.dev
  • URL: https://api.coldrig.dev/campaigns/plan
  • Auth: HTTP bearer

Request body

contactsinteger required
campaignStartstring required

First campaign day, YYYY-MM-DD (UTC).

campaignDaysinteger required
bookingDatestring required

The day you would book, YYYY-MM-DD (UTC); normally today.

domainsAlreadyHeldinteger
listIsOwnOptInboolean

True when the list is your own opted-in donors.

Response

The plan and its price.

mailboxesinteger required
domainsToBuyinteger required
bookBystring required

YYYY-MM-DD

advanceStartOnstring required

YYYY-MM-DD

safeReachinteger required

Contacts the warm-up ramp can safely reach if booked on bookingDate; the price is for this many.

priceCentsinteger required
warningsstring[] required

campaign_day_not_sent_by_default: at least one campaign day falls on a weekday the account does not send on unless the campaign's sendWindow.days includes it (default Monday–Friday); reach and price still count that day, so include 0 and 6 in sendWindow.days at launch to send on weekends.

Changes

No recorded changes to this operation across all 2 revisions of this API.