Delete user (identifyId passed via request body)

DELETE /v1/users/delete

Deletes a user with identifyId specified in delete body This delete method is useful when the identify ID contains special characters that make it impossible to use the delete method with the identifyId in the request path.

HardDelete:

Default behavior is to mark the user as deleted, which will cause it to be hidden in the application. If a user with the same id is created or updated within the next 7 days, the previously deleted record will be revived with all of its associated event history. Conversely, if a user with the same ID is created after 7 days, a totally new record with no event history will be created. To disable the current record from being revived in the future, set the hardDelete flag to true

Query parameters

hardDelete boolean

Hard delete, do not revive if created/updated again in 7 day window

Default value is false.

application/json

Body Required

deleteUser

identifyId string Required

Responses

200 */*

Deleted
Hide response attributes Show response attributes object
- body object
- statusCode string
  
  Values are 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, or 511.
- statusCodeValue integer(int32)
204 */*

No Content
Hide response attributes Show response attributes object
- body object
- statusCode string
  
  Values are 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, or 511.
- statusCodeValue integer(int32)
401

Unauthorized or bad API Key
404

User not found
429

Rate limit exceeded

DELETE /v1/users/delete

curl \
 --request DELETE 'https://api.aptrinsic.com/v1/users/delete' \
 --header "Content-Type: application/json" \
 --data '{"identifyId":"string"}'

Request examples

{
  "identifyId": "string"
}

Response examples (200)

{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 42
}

Response examples (204)

{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 42
}