User Delete


Request Details

Item Value
Description This endpoint is for queuing member deletion requests. The request will be asynchronous, so the response is the initial status and the date/time when the request was successfully queued.
Method DELETE
Endpoint https://[environment]api[client_id].crowdtwist.com/v2/users/[user_id]?api_key=[api_key]&id_type=[id_type]
Content Type JSON (application/json)


Request

Field Name Sample Value Required Format Notes
URL PARAMETERS
user_id alice@crowdtwist.com Yes String Unique ID of the user:
– Email Address
– Facebook User ID
– Twitter User ID
– CrowdTwist ID
– Third Party ID
– Username
– Mobile Phone Number
QUERY STRING PARAMETERS
api_key ABCXYZIOP Yes String Client sends for identification and authentication.
id_type Email No String Type of ID being sent:
– email
– facebook_user_id
– twitter_user_id
– id (CrowdTwist ID) – default ID if id_type is not specified
– third_party_id
– username
– mobile_phone_number

Response Codes

Code Description
200 Successful operation
403 Invalid API key
404 Member not found
400 Unable to initiate deletion
400 Member is inactive but has redeemable points
404 Member ID is invalid
500 Internal Server Error, Service Unavailable

Samples

Sample Request

…/v2/users/564865656?api_key=ABCXYZIOP&id_type=id


Sample Successful Response

{ 
   "user_id": 564865656,
   "status": "Queued"
}