Deletes an existing Person.
Access control
- Permission level
3
or higher is required to delete a Person - Permission level
8
is required to delete another user’s Person
Endpoints
Deleting a Person is possible via these endpoints:
Method | Path | Authentication |
---|---|---|
DELETE | /people/:id/jwt | JSON Web Token |
DELETE | /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 |
---|---|
204 | success |
400 | the request was malformed |
401 | the request lacks authentication |
403 | authentication failed |
500 | server error |
Example request
Javascript
await axios.delete(
'https://backend.freesewing.org/people/27/jwt',
{
headers: {
Authorization: `Bearer ${token}`
}
}
)
Example response
JSON
204
NOTE
These endpoints return status code
204
(no content) on
success, with no response body.