Delete post - Ocoya API Docs

Deletes a post by Post id and cancels all schedules. If the post was already published, the published copy is deleted on every network it went to as well. Networks with no delete API (TikTok, Snapchat, Whop, Twitch) and any network that refused are reported in networkDeletes rather than failing the request, so the post is always deleted in Ocoya. A post that was synced from a network rather than published by Ocoya is only removed from Ocoya.

DELETE

https://www.app.ocoya.com/api/_public/v1/post/{postId}

Delete post

cURL

curl --request DELETE \
  --url https://www.app.ocoya.com/api/_public/v1/post/{postId} \
  --header 'X-API-Key: <api-key>'

{
  "networkDeletes": [
    {
      "provider": "linkedin",
      "providerName": "LinkedIn",
      "socialProfileId": "clh49poxf008x8kov4ncbjty9",
      "status": "deleted",
      "message": "TikTok has no API for deleting a published post. Delete it in the TikTok app."
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

postIdstringrequired

Ocoya post ID.

Example:"cmajvvb9q0003ja5vh0538j6r"

Response

200application/json

Success. Also returned, with an empty networkDeletes, for a post that does not exist.

networkDeletesobject[]

What happened to the published copy on each connected channel.

Show child attributesHide child attributes

networkDeletes.providerstring

Network.

Example:"linkedin"

networkDeletes.providerNamestring

Network name for display.

Example:"LinkedIn"

Social profile the copy was published from.

Example:"clh49poxf008x8kov4ncbjty9"

networkDeletes.statusenum<string>

deleted - removed from the network. already-gone - nothing was there to remove. unsupported - this network has no delete API. failed - the network refused; the post is still up.

Available options: deleted, already-gone, unsupported, failed

Example:"deleted"

networkDeletes.messagestring

What the network said, or what to do instead.

Example:

"TikTok has no API for deleting a published post. Delete it in the TikTok app."

Delete post

cURL

curl --request DELETE \
  --url https://www.app.ocoya.com/api/_public/v1/post/{postId} \
  --header 'X-API-Key: <api-key>'

{
  "networkDeletes": [
    {
      "provider": "linkedin",
      "providerName": "LinkedIn",
      "socialProfileId": "clh49poxf008x8kov4ncbjty9",
      "status": "deleted",
      "message": "TikTok has no API for deleting a published post. Delete it in the TikTok app."
    }
  ]
}

Was this page helpful?