DELETE
/
v1
/
teams
/
{teamId}
/
posts
/
{postId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.social.deletePost({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  postId: process.env.OCTOSPARK_POST_ID ?? "postId",
  query: {},
})
{
  "deleted": true,
  "platformDelete": {
    "provider": "x",
    "platformPostId": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

​
postId
string
required

Post id (UUID), as returned by the create post and list posts endpoints.

Query Parameters

​
alsoDeleteFromPlatform
string
default:false

Pass "true" to also delete the published post from the social platform; any other value (or omission) deletes only the Octospark record.

Example:

"true"

Response

Success

​
deleted
boolean
required
​
platformDelete
object
required