Skip to main content
DELETE
Cancel a post's publishing schedule

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

postId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"post_123"

Query Parameters

withdraw
enum<string>

Set to true to also close the post's open GitHub pull request. Without it, a post with an open pull request returns 409 and nothing is canceled.

Available options:
true,
false

Response

Schedule canceled

Result of canceling the post's schedule.

organization
object
required

Workspace the request ran in.

withdrawn
object | null
required

The pull request closed because withdraw was true. Null when the post had no open pull request.

canceled
integer
required

Destinations that were canceled or cleared.

inProgress
boolean
required

True when a destination was already publishing; it cannot be stopped and finishes on its own.