Pause Sweepstakes
Pause a sweepstakes by providing the SweepstakesToken. This endpoint sets the sweepstakes status to inactive without deleting any data.
POST
sweepstakes/pause
Description
This endpoint allows you to pause a sweepstakes. The sweepstakes must belong to the authenticated user.
Request Body
{
"SweepstakesToken": "uuid-v4-string"
}
Parameters:
- SweepstakesToken (string, required): The unique identifier of the sweepstakes to pause
Code Examples
curl -X POST "https://api-v3.sweeppea.com/sweepstakes/pause" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"SweepstakesToken": "uuid-v4-string"
}'
Response
200 OK
{
"Response": true,
"Message": "Sweepstakes Paused Successfully"
}
Error Responses
401 Unauthorized
{
"Response": false,
"Message": "Invalid or Missing Bearer Token",
"Code": 401
}
403 Forbidden
{
"Response": false,
"Message": "Invalid API Token",
"Code": 403
}
400 Bad Request
{
"Response": false,
"Message": "Missing Required Parameter: SweepstakesToken",
"Code": 400
}
404 Not Found
{
"Response": false,
"Message": "Sweepstakes Not Found",
"Code": 404
}