POST
/
v1
/
users
/
data
/
delete
curl --request POST \
  --url https://api.velt.dev/v1/users/data/delete \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '{
  "data": {
    "userIds": [
      "<string>"
    ],
    "organizationIds": [
      "<string>"
    ]
  }
}'
{
  "result": {
    "status": "success",
    "message": "Deleted user data successfully.",
  }
}

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 etc.

This API may take up to 5 minutes to return a 201 response since it runs an asynchronous job to delete user data across the system. To speed up this process, you can optionally provide the organizationIds where the user belongs.

​
Endpoint

POST https://api.velt.dev/v1/users/data/delete

​
Headers

​
x-velt-api-key
string
required

Your API key.

​
x-velt-auth-token
string
required

Your Auth Token.

​
Body

​
Params

​
data
object
required

​
Example Request

{
  "data": {
    "userIds": [
      "yourUserId1",
      "yourUserId2"
    ],
    "organizationIds": [
      "yourOrganizationId1",
      "yourOrganizationId2"
    ]
  }
}

​
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"
  }
}

{
  "result": {
    "status": "success",
    "message": "Deleted user data successfully.",
  }
}

Was this page helpful?