Delete post

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

Response

200

application/json

200

string

required

teamId

string

required

title

string

required

postDate

string | null

required

status

enum<string>

required

Available options:

DRAFT,

SCHEDULED,

POSTED,

ERROR,

DELETED,

PROCESSING

data

object

required

data.TWITTER

object | null

data.TWITTER.text

string | null

data.TWITTER.uploadIds

string[] | null

data.PINTEREST

object | null

data.PINTEREST.boardName

string

required

data.PINTEREST.text

string | null

data.PINTEREST.description

string | null

data.PINTEREST.uploadIds

string[] | null

data.PINTEREST.link

string | null

The URL to which the Pin will link to.

data.PINTEREST.altText

string | null

The alt text for the image. This is used by screen readers and when the image can't be loaded.

data.PINTEREST.note

string | null

A note about the Pin. This is not visible to the public.

data.PINTEREST.dominantColor

string | null

The dominant color of the image. This is used to display the image before it's loaded.

data.FACEBOOK

object | null

data.FACEBOOK.type

enum<string>

default:

POST

Available options:

POST,

REEL,

STORY

data.FACEBOOK.text

string | null

data.FACEBOOK.uploadIds

string[] | null

data.INSTAGRAM

object | null

data.INSTAGRAM.type

enum<string>

default:

POST

Available options:

POST,

REEL,

STORY

data.INSTAGRAM.text

string | null

data.INSTAGRAM.uploadIds

string[] | null

data.THREADS

object | null

data.THREADS.text

string | null

data.THREADS.uploadIds

string[] | null

data.TIKTOK

object | null

data.TIKTOK.text

string | null

data.TIKTOK.uploadIds

string[] | null

data.TIKTOK.privacy

enum<string> | null

Available options:

SELF_ONLY,

PUBLIC_TO_EVERYONE,

MUTUAL_FOLLOW_FRIENDS,

FOLLOWER_OF_CREATOR

data.TIKTOK.isBrandContent

boolean | null

default:

false

Set to true if the video is a paid partnership to promote a third-party business.

data.TIKTOK.isOrganicBrandContent

boolean | null

default:

false

Set to true if this video is promoting the creator's own business.

data.TIKTOK.disableComments

boolean | null

default:

false

If set to true, other TikTok users will not be allowed to make comments on this post.

data.TIKTOK.disableDuet

boolean | null

default:

false

If set to true, other TikTok users will not be allowed to make Stitches using this post.

data.TIKTOK.disableStitch

boolean | null

default:

false

If set to true, other TikTok users will not be allowed to make Duets using this post.

data.LINKEDIN

object | null

data.LINKEDIN.text

string

required

data.LINKEDIN.uploadIds

string[] | null

data.LINKEDIN.privacy

enum<string> | null

Available options:

CONNECTIONS,

PUBLIC,

LOGGED_IN,

CONTAINER

data.LINKEDIN.hideFromFeed

boolean | null

default:

false

Set to true if the post shouldn't be displayed in the main feed.

data.LINKEDIN.disableReshare

boolean | null

default:

false

Set to true if the post is not allowed to be reshared.

data.YOUTUBE

object | null

data.YOUTUBE.type

enum<string>

default:

SHORT

Available options:

VIDEO,

SHORT

data.YOUTUBE.uploadIds

string[] | null

data.YOUTUBE.text

string | null

data.YOUTUBE.description

string | null

data.YOUTUBE.privacy

enum<string> | null

Available options:

PRIVATE,

PUBLIC,

UNLISTED

data.YOUTUBE.madeForKids

boolean | null

default:

false

Set to true if the video is made for kids.

data.REDDIT

object | null

data.REDDIT.sr

string

required

Subreddit name. Example: r/subredditName or u/username

data.REDDIT.text

string

required

data.REDDIT.description

string | null

data.REDDIT.uploadIds

string[] | null

data.REDDIT.link

string | null

The URL to which the post will link to.

data.REDDIT.nsfw

boolean | null

default:

false

Set to true if the post is NSFW.

data.DISCORD

object | null

data.DISCORD.channelId

string

required

data.DISCORD.text

string | null

data.DISCORD.uploadIds

string[] | null

data.DISCORD.username

string | null

The username to display as the author of the message.

data.DISCORD.avatarUrl

string | null

Avatar url to display as the author of the message.

data.SLACK

object | null

data.SLACK.channelId

string

required

data.SLACK.text

string | null

data.SLACK.uploadIds

string[] | null

data.SLACK.username

string | null

The username to display as the author of the message.

data.SLACK.avatarUrl

string | null

Avatar url to display as the author of the message.

data.MASTODON

object | null

data.MASTODON.text

string | null

data.MASTODON.uploadIds

string[] | null

data.MASTODON.privacy

enum<string> | null

Available options:

PUBLIC,

UNLISTED,

PRIVATE,

DIRECT

data.MASTODON.spoiler

string | null

createdAt

string | null

required

updatedAt

string | null

required

postedDate

string | null

error

string | null

errors

object | null

errors.TWITTER

string | null

errors.PINTEREST

string | null

errors.FACEBOOK

string | null

errors.INSTAGRAM

string | null

errors.TIKTOK

string | null

errors.LINKEDIN

string | null

errors.REDDIT

string | null

errors.DISCORD

string | null

errors.SLACK

string | null

errors.YOUTUBE

string | null

errors.MASTODON

string | null

errors.THREADS

string | null

externalData

object | null

externalData.TWITTER

object | null

externalData.TWITTER.id

string | null

externalData.TWITTER.permalink

string | null

externalData.PINTEREST

object | null

externalData.PINTEREST.id

string | null

externalData.PINTEREST.permalink

string | null

externalData.FACEBOOK

object | null

externalData.FACEBOOK.id

string | null

externalData.FACEBOOK.postId

string | null

externalData.FACEBOOK.videoId

string | null

externalData.FACEBOOK.permalink

string | null

externalData.INSTAGRAM

object | null

externalData.INSTAGRAM.id

string | null

externalData.INSTAGRAM.permalink

string | null

externalData.TIKTOK

object | null

externalData.TIKTOK.id

string | null

externalData.TIKTOK.permalink

string | null

externalData.LINKEDIN

object | null

externalData.LINKEDIN.id

string | null

externalData.LINKEDIN.permalink

string | null

externalData.REDDIT

object | null

externalData.REDDIT.id

string | null

externalData.REDDIT.permalink

string | null

externalData.REDDIT.subreddit_name

string | null

externalData.DISCORD

object | null

externalData.DISCORD.id

string | null

externalData.DISCORD.permalink

string | null

externalData.DISCORD.channelId

string | null

externalData.SLACK

object | null

externalData.SLACK.id

string | null

externalData.SLACK.permalink

string | null

externalData.SLACK.channelId

string | null

externalData.YOUTUBE

object | null

externalData.YOUTUBE.id

string | null

externalData.YOUTUBE.permalink

string | null

externalData.MASTODON

object | null

externalData.MASTODON.id

string | null

externalData.MASTODON.permalink

string | null

externalData.THREADS

object | null

externalData.THREADS.id

string | null

externalData.THREADS.permalink

string | null

deletedAt

string | null

API Documentation

App

Organization

Team

Social account

Upload

Post

Authorizations

Path Parameters

Response