Campaigns

Schedule or cancel a planned start

Schedules an automatic start at plannedStart (ISO 8601 date in the future). The campaign must pass the start checks at scheduling time (same errors as POST .../start). Send null (or an empty value) to cancel a planned start.

patch/advanced/campaigns/{campaignId}/planned-start

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaigns/{campaignId}/planned-start
  • Auth: API key in header Authorization

Path parameters

campaignIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Request body

plannedStartstring date-time nullable

Response

Success.

successunknown
plannedStartstring date-time nullable

Changes

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