Skip to main content
POST
/
gbp
/
posts
/
{id}
/
cancel
Cancel a scheduled GBP post
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/gbp/posts/{id}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "a1b2c3d4-5678-9012-3456-789012345678",
    "status": "cancelled"
  }
}
Cancels a scheduled GBP post. The EventBridge schedule is removed and the post status is set to cancelled. Only posts with status scheduled can be cancelled. To delete a posted or cancelled post, use the Delete endpoint. Scope required: gbp:write

Path parameters

id
string
required
Post ID (UUID).

Response

{
  "data": {
    "id": "a1b2c3d4-5678-9012-3456-789012345678",
    "status": "cancelled"
  }
}
This action cannot be undone. To schedule the post again, use the Reschedule endpoint on a cancelled post (not currently supported — create a new post instead).

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Path Parameters

id
string<uuid>
required

Post ID

Response

Post cancelled

data
object
Last modified on March 27, 2026