Skip to main content
PUT
/
post
cURL
curl --request PUT \
  --url https://our-secret-api-url.com/post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <x-api-key>' \
  --form 'content=<string>' \
  --form parentId=123
{
  "id": 123,
  "snowflakeId": "<string>",
  "user": {
    "id": 123,
    "username": "<string>",
    "bio": "<string>",
    "name": "<string>",
    "image": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "type": "post",
  "hashtags": [
    "<string>"
  ],
  "content": "<string>",
  "media": [
    {
      "id": 123,
      "mediaUrl": "<string>",
      "mimeType": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "repliesCount": 123,
  "replies": "<array>",
  "originalId": 123,
  "parentId": 123,
  "parent": "<unknown>",
  "repostsCount": 123,
  "reposts": [
    123
  ],
  "isSuspended": true,
  "links": [
    {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "image": "<string>"
    }
  ]
}
The route POST /post is used, similar to updating a post.

Authorizations

Authorization
string
header
required

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

Headers

X-API-KEY
string
required

API key required for authentication

Body

multipart/form-data

Updated post content and media

content
string
required

Content of the post

parentId
integer | null
required

ID of the parent post if applicable

Response

Post updated successfully

id
integer
required

ID of the post

snowflakeId
string
required

Snowflake ID of the post

user
object
required

User who created the post

createdAt
string<date-time>
required

Creation timestamp of the post

updatedAt
string<date-time>
required

Last update timestamp of the post

type
enum<string>
required

Type of the post

Available options:
post,
quote,
repost
hashtags
string[]
required

List of hashtags associated with the post without the hashtag symbol (#), e.g. ['viral']

content
string | null

Content of the post

media
object[] | null

List of media items associated with the post

repliesCount
integer | null

Number of replies to the post

replies
array | null

List of replies to the post

originalId
integer | null

ID of the original post if this is a reply, repost & quote repost

parentId
integer | null

ID of the parent post if applicable

parent
object

Parent post if applicable

repostsCount
integer | null

Number of reposts of the post

reposts
integer[] | null

List of userIds reposted

isSuspended
boolean | null

A boolean if the post/reply is suspended or not

List of OpenGraph details associated with the media