Delete User
You can delete a user using the user identifier. All of the user's data will be deleted.
1. Request
1.1 URL
DELETE
https://api.asleep.ai/ai/v1/users/{user_id}
1.2 Header
Field | Type | Required | Description |
---|---|---|---|
x-api-key | String | O | API Key |
1.3 Path Parameter
Field | Type | Required | Description |
---|---|---|---|
user_id | String | O | user id |
Example
curl "https://api.asleep.ai/ai/v1/users/{user_id}" -XDELETE \
-H "x-api-key: <YOUR_API_KEY>"
2. Response
2.1 204 No Content
- User deletion successful
2.2 401 Unauthorized
- The
x-user-id
header value is missing or in an incorrect format
{
"detail": "invalid user id"
}
2.3 404 Not Found
- User not found
{
"detail": "user requested was not found"
}
Updated 12 months ago