Posts
Cancel Post
Cancels a post that has not been published yet. Posts already published stay on the platform.
DELETE
header
x-api-key<token>Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.
id*stringLength
1 <= lengthCancelled
application/json- response
post*Example Request
import { Configuration, PostsApi } from "@onepostly/sdk";const postsApi = new PostsApi( new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await postsApi.cancelPost({ id: "b3e1a7c2-8f4d-4e6a-9c1b-2d3e4f5a6b7c",});console.log(response);Example Response
{ "post": { "id": "b3e1a7c2-8f4d-4e6a-9c1b-2d3e4f5a6b7c", "text": "Ship day", "mediaUrls": [ "https://cdn.onepostly.com/media/product.jpg" ], "mediaKind": "image", "status": "draft", "scheduledFor": "2027-03-15T09:00:00", "timezone": "America/New_York", "destinations": [ { "id": "d4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a", "accountId": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5", "platform": "x", "status": "draft", "externalPostId": "17895695668004550", "externalUrl": "https://x.com/you/status/17895695668004550", "errorCode": "string", "errorMessage": "string", "publishedAt": "2026-08-25T10:00:00.000Z", "metrics": { "impressions": 0, "reach": 0, "likes": 0, "comments": 0, "shares": 0, "saves": 0, "plays": 0, "engagement": 0 } } ], "createdAt": "2026-08-25T10:00:00.000Z", "updatedAt": "2026-08-25T10:00:00.000Z" }}