API Reference/api/user

/api/user

Info
Info

If your user has an oauth account linked, Zipline will attempt to check if the user's access_token's are still valid. If they are invalid, they will return a

200
, tough there is an error message in the response. Only discord and google support refresh tokens, so their token checking is seamless and will not cause a refresh unless it fails.

Responses

{
"error": "oauth token expired",
"redirect_uri": "<redirect uri for oauth provider>"
}

GET
Get user information

200
Ok (JSON)

Returns a user object.

PATCH
Edit user information

Body (JSON)

Each field is optional, and only the fields you specify will be updated.

Field nameTypeDescription
passwordstringUpdate the password, the password supplied will be hashed and stored.
usernamestringUpdate the username.
avatarstringMust be a base64 encoded image, if invalid it may be displayed incorrectly.
embedTitlestringUpdate the embed title used on OG tags
embedColorstringUpdate the embed color used on OG tags
embedSiteNamestringUpdate the embed site name used on OG tags
systemThemestringUpdate the user's theme, this will change the theme on the frontend, if a invalid theme is specified the frontend will default to the system theme.
domainsstring[]Update the user's domains. These domains are used to to provide random domains when uploading files.

200
Ok (JSON)

Returns a user object.

400
Bad Request (JSON)

  • username is already taken - The username you are trying to use is already taken.
  • invalid domains - The domains you are trying to use are invalid. Extra fields: .invalidDomains
Last updated: 3/2/2024
Edit this page on GitHub