Skip to content

Update description endpoint

Alvin Cheng edited this page Apr 23, 2023 · 2 revisions

Description

This is the update description endpoint, as the name suggests this endpoint just updates the description of a user. The endpoint expects a 'username' argument for the user's description to target and a 'description' argument for the description to be replaced. The source of the endpoint is at /endpoints/updateDescription.ts. Furthermore, this endpoint will return a status of '401' on an invalid API key, '500' on an internal server error and '200' on success.

Example

post("http://<URL>/api/update-description?key=<YOUR_API_KEY>", {
  username: "<USERNAME>",
  description: "<DESCRIPTION>",
})
  .then((res) => {
    console.log(res);
  })
  .catch((err) => {
    console.error(err);
  });
Clone this wiki locally