User Deletion Status
Request Details
| Item | Value |
| Description | Returns the status of member's deletion request using the CT User ID. |
| Method | GET |
| Endpoint | https://[environment]-api[client_id].crowdtwist.com/v2/users/delete/[user_id]?api_key=[api_key] |
| Content Type | JSON (application/json) |
Request
| Field Name | Sample Value | Required | Format | Notes |
| URL PARAMETERS | ||||
| user_id | 5464986 | Yes | Integer | Member's CrowdTwist ID |
| QUERY STRING PARAMETERS | ||||
| api_key | QWERTYUIOP | Yes | String | |
Response
Response Body
| Field Name | Sample Value | Required | Format | Description |
| user_id | 43684396 | Yes | Integer | User ID |
| initiated_by | API | Yes | String | API Key name or Control center user's email |
| status | Deletion_initiated | Yes | String |
Current status of deletion:
|
| status_history | See the STATUS HISTORY ARRAY section. | No | Array | Optional array of status history for the deletion |
| STATUS HISTORY ARRAY | ||||
| status | Deletion_initiated | Yes | String |
The status history of member deletion over time:
|
| date | 2022-05-20T10:15:14.511+00:00 | Yes | Date | Date of actions for deletion |
Response Codes
| Code | Description |
| 200 | Success |
| 403 | Invalid API key |
| 404 | Member does not exist or not queued for deletion |
| 500 | Internal Server Error, Service Unavailable |
Samples
Sample Request
Copy
curl -X GET
…/v2/user_deletion/5464986?api_key= QWERTYUIOP
Sample Successful Response
{
"user_id": 5464986,
"initiated_by": "someone@client.com",
"status": "Deletion_in_progress",
"status_history": [
{
"status": "Deletion_initiated",
"date": "2022-05-20T10:15:14.511+00:00"
},
{
"status": "Deletion_in_progress",
"date": "2022-05-21T10:15:14.511+00:00"
}
]
}