Skip to main content
POST
Schedule Project

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Path Parameters

id
string
required

Resource ID

Body

application/json
scheduled_at
string<date-time>
required

ISO 8601 date-time including a timezone offset (e.g. 2025-07-10T09:00:00-04:00). May be now or in the past - the project starts sending as soon as audience compilation finishes (no minimum lead time).

scheduled_timezone
enum<string>
required

US time zone the scheduled time is displayed in. Must be one of the six supported IANA zones.

Available options:
America/New_York,
America/Chicago,
America/Denver,
America/Los_Angeles,
America/Anchorage,
Pacific/Honolulu
Example:

"America/New_York"

Response

Project scheduled.

success
boolean
required
data
object
required