Pixela API Document

API Document for Pixela ( https://pixe.la/ ) .

PUT - /v1/users/<username>

Description

Updates the authentication token for the specified user.

Help page

User - Pixela Help Center

HTTP Method , API endpoint

PUT /v1/users/<username>

Request Header

Key Description
X-USER-TOKEN [required] It is the authentication token specified at the time of user registration.

Request Body

Key Type Description
newToken string [required] It is a new authentication token. The token string is hashed and saved.
Validation rule: [ -~]{8,128}
thanksCode string [optional] Set thanks-code . If it is a valid thanks-code, some limited features will be available. For details, please check How to support Pixela by Patreon ／ Use Limited Features.

Possible errors by HTTP response status code

  • 400 Bad Request
    • This is an error if there is some mistake in your request. Unless the mistake is corrected, the request will not succeed.
  • 403 Forbidden
    • This error occurs when Pixela is unable to process your request due to its terms or specifications.
  • 404 Not Found
    • This error occurs when your request destination does not exist.
    • This error also occurs when authentication to the request destination is not successful.
  • 500 Internal Server Error
    • Status in the event of an unexpected error. Retrying the request may be successfully processed.

Example

$ curl -X PUT https://pixe.la/v1/users/a-know -H 'X-USER-TOKEN:thisissecret' -d '{"newToken":"thisissecret","thanksCode":"ThisIsThanksCode"}'
{"message":"Success.","isSuccess":true}