The Fifth World

Deactivate member

This endpoint deactivates a member. Only administrators can use it.

Request

HTTP Headers
HTTP Header Value
Authorization You must provide a valid JSON Web Token to authenticate yourself as an administrator to use this endpoint.
Path Parameters
Path parameter Value
id The unique ID number of the member you’d like to deactivate.

Examples

Example Request
PATCH /v1/members/1/deactivate HTTP/1.1 Host: api.thefifthworld.com Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Response

If you authenticate with an account with administrative privileges, the endpoint will deactivate the account requested and respond with a 200 HTTP status and a JSON object representing the account’s updated information.

If you failed to authenticate, or authenticated with an account that does not have administrative privileges, the endpoint responds with a 401 HTTP status.

Example

Example Response
{ "id": 1004, "name": "Jason Godesky", "bio": { "markdown": "*The Fifth World* began blah blah blah", "html": "<p><em>The Fifth World</em> began blah blah blah</p>\n" }, "links": { "facebook": "https://facebook.com/jefgodesky", "twitter": "https://twitter.com/jefgodesky", "github": "https://github.com/jefgodesky", "patreon": "https://www.patreon.com/thefifthworld", "web": "https://thefifthworld.com" }, "nopass": false, "admin": true }