Update Rules
Update existing official rules for a specific sweepstakes. Only the rule owner can update their rules.
PUT
/rules/update
Description
This endpoint updates an existing official rule document for a sweepstakes. The rule must exist and belong to the authenticated user. You can update the title, document content, and abbreviated rules for Shopify integration.
Authentication
This endpoint requires Bearer token authentication via the Authorization header.
Request Body
| Parameter | Type | Required | Max Length | Description |
|---|---|---|---|---|
RulesToken |
String (UUID v4) | Yes | 36 | The unique identifier of the rule to update |
SweepstakesToken |
String (UUID v4) | Yes | 36 | The unique identifier of the sweepstakes |
Title |
String | No | 100 | The title of the official rules |
DocumentContent |
String | No | 1,000,000 | The full HTML content of the official rules |
AbbrebiatedRulesForShopify |
String | No | 1,000,000 | Abbreviated rules for Shopify integration |
Note: At least one optional field must be provided to update the rule.
Code Examples
curl -X PUT "https://api-v3.sweeppea.com/rules/update" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"RulesToken": "YOUR_RULES_TOKEN",
"SweepstakesToken": "YOUR_SWEEPSTAKES_TOKEN",
"Title": "Updated Official Rules",
"DocumentContent": "Updated HTML content of official rules...
",
"AbbrebiatedRulesForShopify": "Updated abbreviated rules for Shopify"
}'
Response
200 OK
{
"Response": true,
"Message": "Rule Updated Successfully",
"Data": {
"RulesToken": "bc225a85-c16f-4339-a1d6-d0c6d62fa18d",
"SweepstakesToken": "1770a839-abeb-42b4-b003-888073ba1e9b",
"CreationDate": "2026-01-23T11:30:22.979Z",
"Title": "Updated Official Rules",
"Metadata": {},
"DocumentContent": "Updated HTML content of official rules...
",
"AbbrebiatedRulesForShopify": "Updated abbreviated rules for Shopify",
"EntryPeriods": [],
"Views": [],
"Status": false,
"Primary": true,
"DataUsedToTrainLLModel": false
}
}
Error Responses
400 Bad Request
{
"Response": false,
"Message": "RulesToken is Required",
"Code": 400
}
{
"Response": false,
"Message": "SweepstakesToken is Required",
"Code": 400
}
{
"Response": false,
"Message": "No Fields to Update",
"Code": 400
}
{
"Response": false,
"Message": "Title Must Be a Non-Empty String",
"Code": 400
}
{
"Response": false,
"Message": "Title Exceeds Maximum Length of 100 Characters",
"Code": 400
}
{
"Response": false,
"Message": "DocumentContent Must Be a String",
"Code": 400
}
{
"Response": false,
"Message": "DocumentContent Exceeds Maximum Length of 1000000 Characters",
"Code": 400
}
{
"Response": false,
"Message": "AbbrebiatedRulesForShopify Must Be a String",
"Code": 400
}
{
"Response": false,
"Message": "AbbrebiatedRulesForShopify Exceeds Maximum Length of 1000000 Characters",
"Code": 400
}
401 Unauthorized
{
"Response": false,
"Message": "Invalid or Missing Bearer Token",
"Code": 401
}
403 Forbidden
{
"Response": false,
"Message": "Invalid API Token",
"Code": 403
}
404 Not Found
{
"Response": false,
"Message": "Sweepstakes Not Found",
"Code": 404
}
{
"Response": false,
"Message": "Rule Not Found or Access Denied",
"Code": 404
}
500 Internal Server Error
{
"Response": false,
"Message": "Internal Server Error",
"Code": 500
}