Sweeppea API v3 — Documentation

Base URL: https://api-v3.sweeppea.com Version: 3.0.0 Format: Markdown (GitHub-friendly)

Powerful REST API for managing sweepstakes, participants, winners, and promotional campaigns.

---

Authentication

All requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your account must be active (Status: true) to use the API. Invalid or missing tokens return 401 or 403.

---

Response Format

All endpoints return a consistent JSON structure:

Success:

{
  "Response": true,
  "Data": { },
  "Message": "..."
}

Error:

{
  "Response": false,
  "Message": "...",
  "Code": 400
}

---

MCP Server

Sweeppea Renaissance includes a full Model Context Protocol (MCP) Server implementation, allowing you to integrate the entire platform with any LLM or AI-powered application. Connect your AI assistants, chatbots, and autonomous agents to manage sweepstakes, participants, winners, and more — all through natural language.

• Quick Start: https://mcpdocs.sweeppea.com/#quick-start
• Tools Reference: https://mcpdocs.sweeppea.com/#tools
• Examples: https://mcpdocs.sweeppea.com/#examples

---

Endpoints

Account

Endpoint	Method	Description
account/profile	POST	Fetch user profile info
account/update-profile	POST	Update user profile
account/business	POST	Fetch business info
account/plan	POST	Fetch current plan
account/change-password	POST	Change account password
account/retrieve-password	POST	Retrieve/reset password
account/health-check	POST	API health check

Billing

Endpoint	Method	Description
billing/transactions	POST	Fetch billing transactions
billing/consumptions	POST	Fetch billing consumptions
billing/transfer	POST	Transfer billing credits
billing/datatransfer	POST	Fetch data transfer info

Calendar

Endpoint	Method	Description
calendar/create	POST	Create a calendar event
calendar/fetch	POST	Fetch all calendar events
calendar/single	POST	Fetch a single calendar event
calendar/update	POST	Update a calendar event
calendar/delete	POST	Delete a calendar event

Entry Page

Endpoint	Method	Description
entrypage/fetch	POST	Fetch entry page config
entrypage/fields	POST	Fetch entry page fields
entrypage/settings	POST	Fetch entry page settings
entrypage/update	POST	Update entry page settings (1–5 fields per request)

Files (Drive)

Endpoint	Method	Description
files/upload	POST	Upload a file to the user's Drive
files/fetch	POST	Fetch all files with storage usage and pagination
files/getFileUrl	POST	Generate a short-lived presigned S3 URL to preview or download a file
files/delete	POST	Permanently delete a file
files/send	POST	Send a file by email as an attachment

Help & Support Articles

Endpoint	Method	Description
helpsupport/fetch	POST	Fetch help & support articles

Notes

Endpoint	Method	Description
notes/create	POST	Create an encrypted note
notes/fetch	POST	Fetch all notes
notes/single	POST	Fetch a single note
notes/update	POST	Update a note
notes/delete	POST	Delete a note

Participants

Endpoint	Method	Description
participants/add	POST	Add a participant
participants/fetch	POST	Fetch participants
participants/single	POST	Fetch a single participant
participants/count	POST	Count participants
participants/delete	POST	Delete a participant
participants/create-group	POST	Create a participant group
participants/fetch-group	POST	Fetch participant groups
participants/update-group	POST	Update a participant group
participants/delete-group	POST	Delete a participant group
participants/update-bonus-entries	POST	Update bonus entries for a participant

Rules

Endpoint	Method	Description
rules/create	POST	Create official rules (HTML)
rules/create-wizard	POST	Create official rules (wizard)
rules/fetch	POST	Fetch rules
rules/update	POST	Update rules
rules/delete	POST	Delete rules

Support Tickets

Endpoint	Method	Description
support/create	POST	Create a support ticket
support/open	POST	Fetch open tickets
support/closed	POST	Fetch closed tickets
support/single	POST	Fetch a single ticket
support/update	POST	Update a ticket
support/resolve	POST	Resolve a ticket
support/delete	POST	Delete a ticket

Sweepstakes

Endpoint	Method	Description
sweepstakes/create	POST	Create a new sweepstakes
sweepstakes/fetch	POST	Fetch all sweepstakes
sweepstakes/update	POST	Update a sweepstakes
sweepstakes/delete	POST	Delete a sweepstakes
sweepstakes/clone	POST	Clone a sweepstakes
sweepstakes/pause	POST	Pause a sweepstakes
sweepstakes/unpause	POST	Unpause a sweepstakes

Todos

Endpoint	Method	Description
todos/create	POST	Create a to-do item
todos/fetch	POST	Fetch to-do items

Tools (Utility)

Endpoint	Method	Description
tools/timezones	POST	Fetch all timezones
tools/countries	POST	Fetch all countries
tools/states	POST	Fetch US states
tools/zipcodes	POST	Fetch zip codes
tools/areacodes	POST	Fetch area codes

Wallet

Endpoint	Method	Description
wallet/transactions	POST	Fetch wallet transactions

Winners

Endpoint	Method	Description
winners/draw	POST	Draw a winner
winners/fetch	POST	Fetch winners
winners/scheduled	POST	Schedule a winner draw
winners/fetchscheduled	POST	Fetch scheduled draws
winners/deletescheduled	POST	Delete a scheduled draw

---

Advanced Topics

• Concurrency — Rate limits and concurrent request handling

---

Error Codes

Code	Meaning
200	Success
400	Bad Request — missing or invalid parameters
401	Unauthorized — missing or invalid Bearer token
403	Forbidden — invalid API token or plan limit exceeded
404	Not Found — resource does not exist
500	Internal Server Error

---

Support

• Email: support@sweeppea.com
• Response time: Within 24 hours
• Website: https://www.sweeppea.com