DELETE
/
post
Available on Basic, Premium, Business, Enterprise plans.

Delete a post using the post ID returned from the /post endpoint. You can delete both published and scheduled posts, but there are some differences based on the social network platform:

  • Scheduled posts may be deleted for all social networks platforms.
  • Published posts may be deleted for all social networks platforms except for Instagram and TikTok. Instagram and TikTok do not provide API support for deleting published posts. If you need to delete a published post on these platforms, you must do so manually using their respective mobile apps.

Instagram and TikTok do not support delete via their APIs. Please go to the Instagram or TikTok mobile apps to delete the posts.

Header Parameters

Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
Profile-Key
string
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Body Parameters

id
string
required

Ayrshare Post ID of the post to delete.

Not required if bulk or deleteAllScheduled parameter sent.

If the post is scheduled and still pending, the scheduled posts will be deleted and not sent to the networks.

If the post has already been sent to the networks, the post will be deleted from the networks.

bulk
array

Array of Strings post Ids to bulk delete.

Required if id or deleteAllScheduled parameter not sent.

deleteAllScheduled
boolean
default: false

If true will delete all scheduled posts still in a pending state, i.e. posts that have not yet been published to the networks, for the User Profile.

The id or bulk parameters are ignored if set to true.

This will delete all scheduled posts, so be sure to use this with caution.

markManualDeleted
boolean
default: false

If true, the post will mark as deleted in Ayrshare and prevent Ayrshare from trying to delete the post at the networks.

Please be sure to first delete the post manually at the networks. If the post was not deleted at the networks, an error will be returned in the API response.