Start the data deletion

POST /api/2.0/people/remove/start

Request

Starts the data deletion for the user with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for terminating the reassignment process

userIdstringformat: uuid

User ID whose data is reassigned/removed

Examples

POST /api/2.0/people/remove/start HTTP/1.1
Accept: application/json
Content-Length: 54
Content-Type: application/json
Host: example.com

{
  "userId": "e35af2bc-8e80-46cd-8a11-10e480d055d3"
}

curl --request POST \
  --url https://example.com/api/2.0/people/remove/start \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "e35af2bc-8e80-46cd-8a11-10e480d055d3"
}'

Responses

200

Deletion progress

idstring

ID

errorstring

Error

percentageintegerformat: int32

Percentage

isCompletedboolean

IsCompleted

statusone of

.enum of string

[Created - Created, Running - Running, Completed - Completed, Canceled - Canceled, Failted - Failted]

Can be one of: Created, Running, Completed, Canceled, Failted.

.enum of integer

[0 - Created, 1 - Running, 2 - Completed, 3 - Canceled, 4 - Failted]

Can be one of: 0, 1, 2, 3, 4.

400

User exception

401

Unauthorized

403

No permissions to perform this action

404

User not found