Delete Participant
Delete Participant API endpoint for Sweeppea. DELETE /participants/delete. Remove participant from sweepstakes.
DELETE
participants/delete
Description
This endpoint allows you to delete a participant from a sweepstakes. The participant is identified by ParticipantToken and will be removed from whichever collection it exists in (Participants, ParticipantsAmoe, or OptOuts).
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
SweepstakesToken | String (UUID v4) | Yes | Unique identifier for the sweepstakes |
ParticipantToken | String (UUID v4) | Yes | Unique identifier for the participant |
Code Examples
curl -X DELETE "https://api-v3.sweeppea.com/participants/delete" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"SweepstakesToken": "uuid-v4-string",
"ParticipantToken": "uuid-v4-string"
}'
Response
200 OK
{
"Response": true,
"Message": "Participant Deleted Successfully",
"Data": {
"ParticipantToken": "uuid-v4-string",
"SweepstakesToken": "uuid-v4-string",
"DeletedFrom": ["Participants"],
"DeletedCount": 1
}
}
Error Responses
404 Not Found
{
"Response": false,
"Message": "Participant Not Found in This Sweepstakes",
"Code": 404
}