Delete user

DELETE

/api/v1/users/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/users/1';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/users/1 \
  --header 'Authorization: Bearer <token>'

Deletes a user.

Authorizations

OAuth2
users:delete

Parameters

Path Parameters

required

integer

User ID

Responses

204

Successful

400

Unprocessable Entity

application/json

object

message

required

string

errors

required

object

key

additional properties

Array<string>

Example

{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}