Skip to main content
PATCH
Update Post
Change a post’s title, description or privacy, turn priority streaming on or off, or set who a private post is shared with. Send only the fields you want to change.

Body

Behavior

  • Send a JSON body. At least one field is required.
  • Text over the limit returns 400; it is never truncated. Surrounding whitespace is trimmed.
  • You must own the post. For a team post, use that team’s access key, or your own relay key as a team member who can edit.
  • Moderated posts cannot be changed and return 403 with type moderated.
  • A restricted post cannot be made public and returns 403 with type forbidden. It can still switch between private and unlisted.
  • Team posts are always private. Sending privacy: private on a team post is accepted and changes nothing; any other value returns 403.
  • Making a post public runs the same automatic scan as a new upload.
  • priority: true starts adaptive streaming for every video in the post that is not on it yet, spending your priority minutes. With no minutes left the response is 400 with type quota_exceeded, carrying quota and used in minutes and resets_at. On a lapsed team it is 403 with type forbidden.
  • priority: false removes adaptive streaming from the post’s videos. Minutes already spent are not refunded.
  • access only applies to personal posts that are private, or that this same request makes private. Otherwise it returns 400. Usernames are matched case-insensitively and a leading @ is ignored.
    • An unknown or suspended username returns 404 naming it.
    • Sharing with yourself returns 400.
    • Sharing with someone you block, who blocks you, or whose sharing settings refuse you returns 403 with type forbidden.
    • Each newly added user gets a post_shared notification.
  • Newly @-mentioned users in a changed description get a mention notification.
  • The response includes access for personal posts.
  • The response is the full updated post.

Examples

Change the title and make the post public:
Clear the description:
Share a private post with two people:
Turn on priority streaming:

Responses

Errors

Authorizations

relay-key
string
header
required

Your relay key from snipp.gg/settings/relay

Path Parameters

code
string
required

Post share code.

Body

application/json
title
string | null

Empty string or null clears it.

Maximum string length: 30
description
string | null

Empty string or null clears it.

Maximum string length: 200
privacy
enum<string>
Available options:
public,
unlisted,
private
priority
boolean

Turn priority streaming on or off for the post's videos.

access
string[]

Usernames who can open the post while private. Replaces the list.

Maximum array length: 10

Response

Success

post
object
required