Skip to main content

Get Current Send Plan

GET 

/api/send-plans/current

Get the latest ready working plan, plus the working plan currently calculating (if any). Use this as the entry point: plan is what to act on, calculating tells you a newer plan is on the way.

Required scope: send-plans:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Bearer Personal Access Token with the send-plans:read scope. The token's user also needs permission to view the send planner.

Either key is null when there is no such plan. next_scheduled_run_at is when the next weekly send run starts (ISO 8601, UTC), or null when no weekly run is scheduled.

Request​

Responses​

OK

Response Headers
    Content-Type