Skip to content

Delete Post API

The Delete Post API removes a specific post by its ID. Use it when a post should no longer be retained and you already have the exact postId value from a previous create, list, or retrieval operation.

Delete Post API overview

The Delete Post API deletes a post by its ID. The operation is a single DELETE request to /v1/posts/{postId}, where the postId segment identifies the post to remove. Before calling it, confirm the identifier you intend to delete, because the request itself carries no body and no additional fields to describe the target.

Endpoint

Send a DELETE request to {{API_BASE_URL}}/v1/posts/{postId}. Replace the origin placeholder with the configured API base URL and replace postId in the path with the exact string identifier of the post. The worked example titled Delete a post by ID with cURL shows the request shape, including the x-access-key header used in the example.

Path Parameters

The only path parameter is postId, a required string containing the post ID to delete. There is no request body specified for this operation, so the identifier must be supplied in the path rather than in a JSON payload. If the identifier is missing or does not match an existing post, the operation cannot succeed and the not-found case described below applies.

Response

A successful deletion returns a JSON body with the success field set to true, as shown in the example titled Successful delete response. Treat success as the confirmation signal for this operation: check that the field is present and true before marking the post as deleted in your own records.

Status Codes

A 200 response means Post deleted and is paired with the success response body. A 404 response means Post not found, which indicates the supplied postId did not match an existing post. Distinguish these two outcomes in client code: only the 200 case should be treated as a completed deletion, while 404 should trigger a check of the identifier or a refresh of the post list rather than a retry of the same value.

Related operations

Related operations include the Get Post API for retrieving a single post by its ID before deletion, and the Schedule Post API for scheduling a post for a specific date, time, and timezone. Reviewing the current state of a post before deleting it can help confirm that the postId in the DELETE request is the intended target.

Path Parameters field map
ParameterTypeRequiredDescription
postIdstringYes, in pathThe post ID to delete

Exact source contract; origin modularized as {{API_BASE_URL}}.

Status codes and failure matrix
Status CodeMeaningResponse SignalClient Action
200Post deletedsuccess: trueTreat the post as deleted.
404Post not foundNo success confirmation specifiedVerify the postId value or refresh the post list before retrying.

Exact source status meanings; no additional codes specified in source.

Delete a post by ID with cURL
curl -X DELETE "{{API_BASE_URL}}/v1/posts/post_abc123" \
  -H "x-access-key: YOUR_API_KEY"
Successful delete response
{
	"success": true
}
Contract example 1
DELETE {{API_BASE_URL}}/v1/posts/{postId}