Sweeppea API v3

Fetch Entry Page Settings

Retrieve the entry page settings for a given sweepstakes. Validates that the entry page belongs to both the sweepstakes and the authenticated user.

POST https://api-v3.sweeppea.com/entrypage/settings

Description

This endpoint retrieves the entry page settings associated with the given SweepstakesToken. Ownership is enforced — the entry page must belong to both the specified sweepstakes and the authenticated user. Returns EntryPageToken, SweepstakesToken, CreationDate, EntryPageTitle, and the full Settings object.

Authentication

This endpoint requires Bearer token authentication via the Authorization header.

Request Body

Field Type Required Description
SweepstakesToken String Yes Unique identifier of the sweepstakes (UUID v4)

Code Examples

curl -X POST "https://api-v3.sweeppea.com/entrypage/settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"SweepstakesToken":"uuid-v4-string"}'

Response

{
  "Response": true,
  "Data": {
    "EntryPageToken": "uuid-v4-string",
    "SweepstakesToken": "uuid-v4-string",
    "EntryPageTitle": "My Entry Page",
    "Settings": {
      "SweepstakesHandler": "MYHANDLER",
      "EntryPageType": 2,
      "EntryPageHeadline": "Welcome!",
      "EntryPageDescription": "Complete the entry form to participate.",
      "EmailOptInSwitch": false,
      "SMSTextOptInSwitch": false,
      "BonusEntriesSwitch": false,
      "TermsConditionsSwitch": false,
      "ReCaptcha": true,
      "GeoLocation": true,
      "CollectStatistics": true,
      "..."  : "..."
    },
    "CreationDate": "2026-02-19T16:03:16.917Z"
  }
}

Error Responses

{
  "Response": false,
  "Message": "SweepstakesToken is Required",
  "Help": {
    "ExpectedBody": {
      "SweepstakesToken": "string (required) \u2014 UUID v4 of the sweepstakes"
    }
  },
  "Code": 400
}
{
  "Response": false,
  "Message": "Missing or invalid Bearer token. Send your API token in the Authorization header as: Authorization: Bearer YOUR_API_TOKEN",
  "Code": 401
}
{
  "Response": false,
  "Message": "Invalid API token. It does not match any account.",
  "Code": 403
}
{
  "Response": false,
  "Message": "Entry Page Not Found",
  "Code": 404
}
{
  "Response": false,
  "Message": "Internal server error. Please try again; if it persists, contact support with the time of this request.",
  "Code": 500
}

Important Notes

  • 🔒 Ownership Verification: The entry page must belong to both the SweepstakesToken and the authenticated user
  • 🆔 Sweepstakes Identification: Sweepstakes are identified by their unique SweepstakesToken (UUID v4)
  • ⚙️ Full Settings: The Settings object contains all entry page configuration including design, security, webhooks, social, bonus entries, and more
  • 🔍 Not Found: Returns 404 if the entry page doesn't exist or belongs to another user or sweepstakes
© Sweeppea. All rights reserved.