Engage

Cancel a team engagement

Cancels a waiting or pending teammate engagement or reshare created in the current workspace. Sending and completed engagements cannot be cancelled.

DELETE/api/public/team-engagements
cURLDELETE /api/public/team-engagements
curl -X DELETE https://postiv.ai/api/public/team-engagements \
  -H "Authorization: Bearer pk_postiv_..." \
  -H "Content-Type: application/json" \
  -d '{"id":"22222222-2222-4222-8222-222222222222"}'
200Response
{
  "cancelled": true,
  "id": "22222222-2222-4222-8222-222222222222"
}

Authorization

Requires an organization API key with the engage:write scope, sent as Authorization: Bearer or x-api-key.

Body parameters

iduuidrequired

Public engagement UUID returned by queue-team-engagement or list-team-engagements.

Response

Cancellation confirmation.

cancelledboolean
iduuid

Errors

400id is not a UUID
404Engagement not found in this workspace
409Engagement is already sending or completed

Good to know

  • Requires engage:write. The engagement creator or a workspace admin may cancel it.