PeerTube
  1. My User
PeerTube
  • Abuses
    • List abuses
      GET
    • Report an abuse
      POST
    • Delete an abuse
      DELETE
    • Update an abuse
      PUT
    • List messages of an abuse
      GET
    • Add message to an abuse
      POST
    • Delete an abuse message
      DELETE
    • List my abuses
      GET
  • Accounts
    • List accounts
      GET
    • Get an account
      GET
    • List ratings of an account
      GET
    • List videos of an account
      GET
  • Video Channels
    • List video channels of an account
      GET
    • List video channels
      GET
    • Create a video channel
      POST
    • Delete a video channel
      DELETE
    • Get a video channel
      GET
    • Update a video channel
      PUT
    • Delete channel avatar
      DELETE
    • Update channel avatar
      POST
    • Delete channel banner
      DELETE
    • Update channel banner
      POST
  • Config
    • Get instance public configuration
    • Get instance "About" information
    • Delete instance runtime configuration
    • Get instance runtime configuration
    • Set instance runtime configuration
  • Homepage
    • Get instance custom homepage
    • Set instance custom homepage
  • Feeds
    • List videos of subscriptions tied to a token
    • List comments on videos
    • List videos
  • Job
    • List instance jobs
  • Session
    • Login prerequisite
    • Logout
    • Login
  • Plugins
    • List plugins
    • List available plugins
    • Install a plugin
    • Uninstall a plugin
    • Update a plugin
    • Get a plugin
    • Get a plugin's public settings
    • Get a plugin's registered settings
    • Set a plugin's settings
  • Search
    • Search channels
    • Search playlists
    • Search videos
  • Account Blocks
    • List account blocks
    • Block an account
    • Unblock an account by its handle
  • Server Blocks
    • List server blocks
    • Block a server
    • Unblock a server by its domain
  • Instance Follows
    • List instances following the server
    • Remove or reject a follower to your server
    • Accept a pending follower to your server
    • Reject a pending follower to your server
    • List instances followed by the server
    • Follow a list of actors (PeerTube instance, channel or account)
    • Unfollow an actor (PeerTube instance, channel or account)
  • Video Mirroring
    • List videos being mirrored
    • Mirror a video
    • Delete a mirror done on a video
  • Instance Redundancy
    • Update a server redundancy policy
  • Users
    • List users
    • Create a user
    • Resend user verification link
    • Register a user
    • Delete a user
    • Get a user
    • Update a user
    • Verify a user
  • My User
    • Get my user information
      GET
    • Update my user information
      PUT
    • Delete my avatar
      DELETE
    • Update my user avatar
      POST
    • Get my user used quota
      GET
    • Get videos of my user
      GET
    • Get rate of my user for a video
      GET
  • My History
    • List watched videos history
    • Clear video history
  • My Notifications
    • Update my notification settings
    • List my notifications
    • Mark notifications as read by their id
    • Mark all my notification as read
  • My Subscriptions
    • Get my user subscriptions
    • Add subscription to my user
    • Get if subscriptions exist for my user
    • List videos of subscriptions of my user
    • Delete subscription of my user
    • Get subscription of my user
  • Video Playlists
    • Check video exists in my playlists
    • List video playlists
    • Create a video playlist
    • List available playlist privacy policies
    • Delete a video playlist
    • Get a video playlist
    • Update a video playlist
    • Reorder a playlist
    • Delete an element from a playlist
    • Update a playlist element
  • Videos
    • Get video imports of my user
    • List videos of a playlist
    • Add a video in a playlist
  • Video
    • List videos of a video channel
    • List videos
    • List available video categories
    • Import a video
    • List available video languages
    • List available video licences
    • List available video privacy policies
    • Upload a video
    • Cancel the resumable upload of a video, deleting any data uploaded so far
    • Initialize the resumable upload of a video
    • Send chunk for the resumable upload of a video
    • Delete a video
    • Get a video
    • Update a video
    • Get complete video description
    • Add a view to a video
    • Set watching progress of a video
  • Video Blocks
    • List video blocks
    • Unblock a video by its id
    • Block a video
  • Live Videos
    • Create a live
    • Get information about a live
    • Update information about a live
  • Video Ownership Change
    • List video ownership changes
    • Accept ownership change request
    • Refuse ownership change request
    • Request ownership change
  • Video Captions
    • List captions of a video
    • Delete a video caption
    • Add or replace a video caption
  • Video Comments
    • List threads of a video
    • Create a thread
    • Get a thread
    • Delete a comment or a reply
    • Reply to a thread of a video
  • Video Rates
    • Like/dislike a video
  1. My User

Update my user information

Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
PUT
/users/me
My User
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://peertube2.cpy.re/api/v1/users/me' \
--header 'Content-Type: application/json' \
--data-raw '{
    "autoPlayNextVideo": true,
    "autoPlayNextVideoPlaylist": true,
    "autoPlayVideo": true,
    "currentPassword": "pa$$word",
    "displayNSFW": "true",
    "displayName": "string",
    "email": {},
    "noInstanceConfigWarningModal": true,
    "noWelcomeModal": true,
    "password": "pa$$word",
    "theme": "string",
    "videoLanguages": [
        "string"
    ],
    "videosHistoryEnabled": true,
    "webTorrentEnabled": true
}'
Response Response Example
{}

Request

Body Params application/json
autoPlayNextVideo
boolean 
optional
new preference regarding playing following videos automatically
autoPlayNextVideoPlaylist
boolean 
optional
new preference regarding playing following playlist videos automatically
autoPlayVideo
boolean 
optional
new preference regarding playing videos automatically
currentPassword
string <password>
optional
>= 6 characters<= 255 characters
displayNSFW
enum<string> 
optional
new NSFW display policy
Allowed values:
truefalseboth
displayName
string 
optional
new name of the user in its representations
>= 3 characters<= 120 characters
email
object 
optional
new email used for login and service communications
noInstanceConfigWarningModal
boolean 
optional
noWelcomeModal
boolean 
optional
password
string <password>
optional
>= 6 characters<= 255 characters
theme
string 
optional
videoLanguages
array[string]
optional
list of languages to filter videos down to
videosHistoryEnabled
boolean 
optional
whether to keep track of watched history or not
webTorrentEnabled
boolean 
optional
whether to enable P2P in the player or not
Examples

Responses

🟢204successful operation
application/json
Body
object {0}
Modified at 2022-09-10 22:29:50
Previous
Get my user information
Next
Delete my avatar
Built with