Users
Delete All User Data (GDPR)
Remove All User data from Velt.
POST
/
Use this API to remove all user data from Velt. This will:
- remove their access from all the documents and data in the organization.
- remove them from @mention contact dropdown list.
- remove them from @mentions where they were tagged.
- remove all feature data created by the user. eg: comments, reactions, notifications etc.
Endpoint
https://deleteuserdata.api.velt.dev
Headers
x-velt-api-key
string
requiredYour API key.
x-velt-auth-token
string
requiredYour Auth Token.
Body Example
Params
data
object
requiredExample Request
{
"data": {
"userIds": [
"yourUserId1",
"yourUserId2"
]
}
}
Response
Success Response
{
"result": {
"status": "success",
"message": "User(s) deleted successfully.",
"data": {
"yourUserId1": {
"success": true,
"message": "User removed."
}
}
}
}
User(s) Not Found
{
"result": {
"status": "success",
"message": "Deleted user data successfully.",
}
}
Failure Response
{
"error": {
"message": "ERROR_MESSAGE",
"status": "INVALID_ARGUMENT"
}
}
Was this page helpful?