Campaigns

Launch

Starts sending. Launch only after the user said yes. The answer carries variable_coverage: people without a value for a variable of the emails wait at that email and never get a blank. Refused with launch_blocked and the list of blockers while the campaign has no email, no mailbox with room, no people, or text that would go out as written ([link], TBD). When that text is meant, launch with allow_placeholders: true.

CostWhat it doesKey scopes
Free; emails count against the plan's monthly campaign email allowanceSends emailargorant:manage_lists
post/api/v1/campaigns/{campaign_id}/launch

Request

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

Path parameters

campaign_idstring uuid required

The campaign id from create or list.

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

allow_placeholdersboolean

Send leftover placeholders as written. Only after the user saw them.

Response

OK

Changes

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