MImigma
Campaigns

Schedule Campaign

Changed on

Schedule a campaign for future delivery. scheduledAt must be in the future. Requires API key with campaign:write.

post/v1/campaigns/{id}/schedule

Request

  • Base URL
    https://api.migma.ai
  • URL
    https://api.migma.ai/v1/campaigns/{id}/schedule
  • Auth
    API key in header Authorization

Path parameters

idstring required

Campaign ID

Headers

Idempotency-Keystring

Optional key (max 100 chars) for safe retries. Same key + same body within 24h replays the original response (same status and body); same key + a different body returns 409 IDEMPOTENCY_CONFLICT. Scoped per API key.

Request body

scheduledAtstring date-time required

ISO 8601 datetime for sending

scheduledTimezonestring

IANA timezone (e.g. America/New_York). Defaults to UTC.

localTimeDeliveryboolean

Send at the clock time of scheduledAt in scheduledTimezone, in each contact's own time zone, based on their country. Requires scheduledTimezone. Contacts without a country get it at scheduledAt. Where that time has already passed, contacts get it at the same time the next day. Countries with several time zones use their most populous one. Not available with A/B tests, batch sending or other providers (422). Omit to keep the campaign's current setting; false turns it off. Sending a scheduled campaign early sends to everyone at once.

Response

Campaign scheduled

successboolean required
errorstring nullable

Changes

  • a05e96553523Revision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • 6b3357db6cf6Revision changes
    • info

      added the optional property // to the response with the status