Posts
Update Post
Change a post’s title, description or privacy. Relay also accepts priority and access.
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.
Clear the description:
Share a private post with two people:
Turn on priority streaming:
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
403with typemoderated. - A restricted post cannot be made public and returns
403with typeforbidden. It can still switch betweenprivateandunlisted. - Team posts are always private. Sending
privacy: privateon a team post is accepted and changes nothing; any other value returns403. - Making a post public runs the same automatic scan as a new upload.
priority: truestarts adaptive streaming for every video in the post that is not on it yet, spending your priority minutes. With no minutes left the response is400with typequota_exceeded, carryingquotaandusedin minutes andresets_at. On a lapsed team it is403with typeforbidden.priority: falseremoves adaptive streaming from the post’s videos. Minutes already spent are not refunded.accessonly applies to personal posts that are private, or that this same request makes private. Otherwise it returns400. Usernames are matched case-insensitively and a leading@is ignored.- An unknown or suspended username returns
404naming it. - Sharing with yourself returns
400. - Sharing with someone you block, who blocks you, or whose sharing settings refuse you returns
403with typeforbidden. - Each newly added user gets a
post_sharednotification.
- An unknown or suspended username returns
- Newly @-mentioned users in a changed
descriptionget amentionnotification. - The response includes
accessfor personal posts. - The response is the full updated post.
Examples
Change the title and make the post public:Responses
Errors
Authorizations
Your relay key from snipp.gg/settings/relay
Path Parameters
Post share code.
Body
application/json
Empty string or null clears it.
Maximum string length:
30Empty string or null clears it.
Maximum string length:
200Available options:
public, unlisted, private Turn priority streaming on or off for the post's videos.
Usernames who can open the post while private. Replaces the list.
Maximum array length:
10Response
Success