GTM verbs

post/v1/launch_campaign

Request

  • Base URL: https://api.layrcake.dev
  • URL: https://api.layrcake.dev/v1/launch_campaign
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Required when confirmation_token is present; reuse it after timeout.

Request body

campaign_idstring uuid required
confirmation_tokenstring
daily_send_limitinteger
dry_runboolean
supersedesstring uuid

The confirmation_token of the approval this request replaces. Needed only when that approval was already approved and hasn't started yet; one still waiting for a decision is replaced automatically. Only where Layrcake runs approved actions itself (the result's approval block says execution: server); anywhere else it is refused. A dry run doesn't check it, so it refuses it: send it on the call itself.

first_send_not_beforestring date-time

The earliest the first emails may go out (ISO 8601). They start at the first sending-window opening at least 60 minutes after a person approves, and not before this time. It can't be later than the approval's lifetime after this request (7 days by default); a later time is refused. Only where Layrcake runs approved actions itself (the result's approval block says execution: server); anywhere else it is refused. A dry run doesn't check it, so it refuses it: send it on the call itself.

Response

Successful outcome

OR

Changes

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