Delete User

DELETE /v1/auth/users/{user_id}/delete

Authorization

Delete a user by ID.

HTTP Request

DELETE /v1/auth/users/{user_id}/delete

Returns

A successful response returns an object with message and user_id properties.

Path parameters

user_id string Required

Unique User ID of the user.

Responses

200 application/json
Hide response attributes Show response attributes object
- message string Required
  
  Success message of the action.
  
  Minimum length is 1.
- user_id string Required
  
  Unique User ID of the deleted user.
  
  Minimum length is 1.

DELETE /v1/auth/users/{user_id}/delete

curl \
 --request DELETE 'https://api.streambird.io/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2/delete' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "message": "Successfully deleted user",
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2"
}