1
0
Fork 0
freesewing/markdown/dev/reference/backend/people/delete/en.md

1.5 KiB

title
Delete a Person

Deletes an existing Person.

Access control

Endpoints

Deleting a Person is possible via these endpoints:

Method Path Authentication
/people/:id/jwt JSON Web Token
/people/:id/key API Key & Secret

Request URL

The URL should contain the ID of the Person you wish to remove. It replaces the :id placeholder in the endpoints listed above.

Response status codes

Possible status codes for these endpoints are:

Status code Description
success
the request was malformed
the request lacks authentication
authentication failed
server error

Example request

await axios.delete(
  'https://backend.freesewing.org/people/27/jwt',
  {
    headers: {
      Authorization: `Bearer ${token}`
    }
  }
)

Example response

These endpoints return status code (no content) on success, with no response body.