Skip to main content
Glama

Server Details

Manage sweepstakes, participants, and winner drawings with legal compliance in the US and Canada. Access requires an active Sweeppea subscription and API Key.

Status
Healthy
Last Tested
Transport
Streamable HTTP
URL

See and control every tool call

Log every tool call with full inputs and outputs
Control which tools are enabled per connector
Manage credentials once, use from any MCP client
Monitor uptime and get alerted when servers go down

Available Tools

63 tools
add_participantInspect

Add a new participant to a sweepstakes. Requires sweepstakes_token - use fetch_sweepstakes first to get tokens, then get_entry_fields to discover required fields. Field names must use underscores instead of spaces (e.g., "First_Name" not "First Name"). RULES: Only ONE participant at a time. NEVER add participants in bulk, batch, or loops. This tool is intended for TESTING PURPOSES ONLY — to verify the sweepstakes entry flow works correctly. Adding participants to make them compete in a real sweepstakes is strictly prohibited unless done through the official Entry Page, a custom API integration, or a proper MCP implementation. If a user requests mass loading (e.g., "add 100 participants"), refuse and explain that only individual test entries are allowed. HONESTY: After calling this tool, report EXACTLY what the API returned. If the API returns an error, report the error truthfully. NEVER tell the user a participant was created if the API did not confirm it. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
emailYesParticipant email address (used as KeyEmail)
phoneNoParticipant phone number (used as KeyPhoneNumber, optional)
fieldsYesForm fields object. Keys must use underscores for spaces (e.g., {"First_Name": "John", "Last_Name": "Doe"})
bonus_entriesNoNumber of bonus entries (optional, default: 0)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
clone_sweepstakesInspect

Clone an existing sweepstakes with new parameters. Use fetch_sweepstakes first to get the handler of the sweepstakes to clone. Creates a complete copy including entry pages, calendar events, short links, groups, and all configurations. CRITICAL: This is a billable operation. ALWAYS confirm with the user before cloning. NEVER clone multiple sweepstakes in batch or loops without explicit user approval for each one. LIMITS: Maximum 3 active sweepstakes and 10 total (active + inactive). Before cloning, use fetch_sweepstakes to verify the account has not reached these limits. If limits are reached, refuse the operation and inform the user. Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
handlerYesThe identifier (handler) of the original sweepstakes to clone
end_dateYesEnd date in YYYY-MM-DD format
end_timeYesEnd time in HH:MM format (24-hour)
start_dateYesStart date in YYYY-MM-DD format
start_timeYesStart time in HH:MM format (24-hour)
handler_newYesThe unique identifier (handler) for the newly created sweepstakes
sweepstakes_nameYesDisplay name for the cloned sweepstakes
count_participantsInspect

Get participant counts for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. Supports filtering by type (all, participants, amoe, optouts) and date range.

ParametersJSON Schema
NameRequiredDescriptionDefault
end_dateNoEnd date filter (ISO 8601 format, e.g., 2025-12-31)
start_dateNoStart date filter (ISO 8601 format, e.g., 2025-01-01)
filter_typeNoFilter type: all (default), participants, amoe (alternate method of entry), or optouts
sweepstakes_tokenYesThe sweepstakes token (UUID format)
create_calendar_eventInspect

Create a new calendar event with title, dates, and optional details like location, time, and notifications. DATE RULE: The API server uses UTC. Today's date may be rejected as "past" depending on the user's local timezone. To be safe, always use tomorrow's date or later when creating events. NEVER use today's date — it will fail with "Cannot Create Events In The Past". If the user asks to create an event for today, explain this limitation and suggest tomorrow instead.

ParametersJSON Schema
NameRequiredDescriptionDefault
colorNoEvent color in hex format, e.g., #FF5733 (optional)
titleYesEvent title (required)
statusNoEvent status (optional)
all_dayNoWhether this is an all-day event (optional, default: false)
end_dateYesEnd date in ISO 8601 format, e.g., 2026-01-20 (required)
end_timeNoEnd time in HH:MM format, e.g., 17:00 (optional)
latitudeNoLocation latitude coordinate (optional)
locationNoEvent location (optional)
completedNoMark event as completed (optional, default: false)
event_urlNoURL associated with the event (optional)
longitudeNoLocation longitude coordinate (optional)
start_dateYesStart date in ISO 8601 format, e.g., 2026-01-20 (required)
start_timeNoStart time in HH:MM format, e.g., 09:00 (optional)
descriptionNoEvent description (optional)
notificationNoNotification settings (optional)
private_eventNoWhether this is a private event (optional, default: false)
people_involvedNoPeople involved in the event (optional)
sms_notificationNoEnable SMS notifications (optional, default: false)
repeat_this_eventNoRepeat configuration for recurring events (optional)
create_groupInspect

Create a new group within a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. Groups are used to organize and segment participants.

ParametersJSON Schema
NameRequiredDescriptionDefault
group_nameYesThe name of the group (must be unique within the sweepstakes)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
create_noteInspect

Create a new note. Content is automatically encrypted using AES-256-CBC encryption before storage. FORMAT: Only these HTML tags are allowed: , , , , , , , , , , , , , . NEVER insert scripts, iframes, event handlers (onclick, onerror, etc.), style tags, or any executable code. SPACING: Do NOT use   between sections — it creates ugly blank blocks in the UI. Instead, rely on natural HTML block element spacing. Place content directly inside tags: TitleTextItem. Only use inside a tag when you need a line break within a paragraph.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesNote title (max 100 characters, must be unique)
pinnedNoPin note to top of list (default: false)
contentYesNote content (max 100,000 characters, will be encrypted). Allowed HTML: <h1>-<h6>, <p>, <a>, <br>, <strong>, <i>, <ul>, <ol>, <li>. No scripts, iframes, or executable code.
create_ruleInspect

Create a new official rules document for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. SECONDARY RULES WARNING: Before creating rules, call fetch_rules to check if the sweepstakes already has primary rules. If primary rules already exist, WARN the user that the new rules will be created as SECONDARY and will NOT be the ones published on the Entry Page or assigned to the short URL (swpp.me/r/[handler]). The short URL always points to the primary rules. The user can change which rules are primary in the Official Rules section of the app. Only proceed after the user acknowledges this. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesTitle of the official rules document (max 100 characters)
document_contentYesFull HTML content of the official rules (max 1,000,000 characters)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
create_rules_wizardInspect

Generate official sweepstakes rules via the 14-step wizard. MANDATORY WORKFLOW: Before calling this tool you MUST call fetch_sweepstakes to identify the target sweepstakes and get its token, dates, and name. Then call get_business and get_profile to pre-fill sponsor information (name, address, city, state, zip, phone, email). This reduces the number of questions you need to ask the user. Only ask the user for information you cannot obtain from those endpoints. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally for tool chaining only. STEP-BY-STEP RULE: You MUST follow the wizard steps in strict sequential order (A through N). Ask each question one at a time or in small logical groups. Do NOT skip steps or assume answers. Always wait for the user to respond before moving to the next step. Maintain order throughout the entire process. NO FABRICATION RULE: NEVER invent, assume, or fabricate any data for the wizard fields. Every value must come from the user directly or from a pre-fetch API call (fetch_sweepstakes, get_business, get_profile). If a required value is missing, ask the user — do not fill it with placeholder or guessed data. NO PAST DATES RULE: All dates and times must be in the present or future — never accept past dates. If the user provides today's date, verify the time has not already passed. This applies to start_date, end_date, winner_drawing_date, winner_notification_date, and all entry_period_items dates. If a date or time is in the past, reject it and ask the user to provide a valid future date/time. PRIMARY RULES LINK: After successfully creating rules, if the result indicates the document is primary (is_primary: true), provide the user with the public rules URL: https://swpp.me/r/[handler] where [handler] is the sweepstakes handler/keyword in lowercase (obtained from fetch_sweepstakes during the mandatory pre-fetch step). PLAIN LANGUAGE RULE: Always write options in simple, everyday language that anyone can understand. Never use math symbols like >=, <=, <, > in user-facing text. Instead of ">=5000" write "$5,000 or more". Instead of "<5000" write "Less than $5,000". Describe everything as if explaining to someone with no technical background. QUESTION FORMAT: Number each question sequentially (1, 2, 3...) and list the options within each question using lowercase letters (a, b, c...). The user can reply with just the number and letter. Group related questions together. Example: "1. Prize value: a) $5,000 or more, b) Less than $5,000 | 2. Alcohol related: a) Yes, b) No | 3. Entry method: a) Website, b) SMS, c) Social Media..." This makes the process faster and reduces typing. Never use bullet points — always numbered questions with lettered options. SECONDARY RULES WARNING: Before creating rules, call fetch_rules to check if the sweepstakes already has primary rules. If primary rules already exist, WARN the user that the new rules will be created as SECONDARY and will NOT be the ones published on the Entry Page or assigned to the short URL (swpp.me/r/[handler]). The short URL always points to the primary rules. The user can change which rules are primary in the Official Rules section of the app. Only proceed after the user acknowledges this. ENUM REFERENCE — method_of_entry: 1=Website, 2=SMS, 3=Social Media, 4=Other, 5=Purchase ($1=1 entry), 6=Purchase (1 order=1 entry), 7=Donation, 8=Subscription. states: 1=All 50 + DC, 2=All 50 + DC + PR, 3=All 50 + DC + All Territories, 4=Select specific states, 5=US & Canada (excl. Quebec), 6=US & Canada (excl. Quebec) + PR, 7=US & UK, 8=US & Mexico, 9=Worldwide, 10=US, Canada (excl. Quebec) & Mexico. min_age: 1=18+, 2=21+, 3=13+ with parental consent. arv: 1=ARV >= $5000, 2=ARV < $5000. alcohol_sweeps: 1=alcohol-related, 2=non-alcohol. entry_period_selector: 1=single drawing period, 2=multiple entry periods. sweeppea_entry_page: 1=Sweeppea hosted page, 2=custom URL, 3=none.

ParametersJSON Schema
NameRequiredDescriptionDefault
arvYesApproximate Retail Value threshold. 1 = ARV >= $5,000. 2 = ARV < $5,000.
statesYesGeographic eligibility. 1=All 50+DC, 2=+PR, 3=+All Territories, 4=Select specific, 5=US&Canada, 6=US&Canada+PR, 7=US&UK, 8=US&Mexico, 9=Worldwide, 10=US,Canada,Mexico.
min_ageYesMinimum age: 1=18+, 2=21+, 3=13+ with parental consent.
end_dateYesEnd date (YYYY-MM-DD).
end_timeYesEnd time (e.g. "11:59 PM" or "23:59").
start_dateYesStart date (YYYY-MM-DD).
start_timeYesStart time (e.g. "09:00 AM" or "14:00").
prize_valueYesTotal prize value in USD. Must be > 0.
end_timezoneYesEnd timezone.
sponsor_cityYesSponsor city. Pre-fill from get_business.
sponsor_nameYesLegal sponsor name. Pre-fill from get_business.
sponsor_emailNoSponsor email (optional). Pre-fill from get_profile.
sponsor_stateYesSponsor state or abbreviation. Pre-fill from get_business.
alcohol_sweepsYesIs this an alcohol-related sweepstakes? 1 = Yes, 2 = No.
list_of_statesNoArray of state names. Required when states = 4.
rules_languageNoRules language code. Default: "en".
start_timezoneYesStart timezone (e.g. "US/Eastern", "EST", "CST").
method_of_entryYesEntry method: 1=Website, 2=SMS, 3=Social Media, 4=Other, 5=Purchase ($1=1 entry), 6=Purchase (1 order=1 entry), 7=Donation, 8=Subscription.
sponsor_addressYesSponsor street address. Pre-fill from get_business.
winners_to_drawNoNumber of winners to draw (>= 1). Required when entry_period_selector = 1.
prize_is_vehicleYesIs the prize a vehicle?
sponsor_zip_codeYesSponsor zip code (5 digits). Pre-fill from get_business.
sweepstakes_nameYesOfficial promotional name (6-60 characters).
custom_entry_pageNoCustom entry page URL (min 11 chars). Required when sweeppea_entry_page = 2.
other_descriptionNoOther entry method description. Required when method_of_entry = 4.
prize_descriptionYesDetailed prize description (max 5000 chars).
sponsor_telephoneNoSponsor phone number (optional). Pre-fill from get_profile.
sweepstakes_tokenYesSweepstakes token (UUID). Get via fetch_sweepstakes.
entry_period_itemsNoArray of period objects. Required when entry_period_selector = 2. Each object: { start_date, start_time, end_date, end_time, drawing_date, winners_drawn, notification_date, prize_description, prize_value }.
privacy_policy_urlYesPrivacy policy URL (min 11 chars, must include http/https).
sweeppea_entry_pageYes1 = Sweeppea hosted page, 2 = custom URL, 3 = none.
winner_drawing_dateNoDrawing date (YYYY-MM-DD). Required when entry_period_selector = 1.
winner_drawing_timeNoDrawing time. Required when entry_period_selector = 1.
prize_include_travelYesDoes the prize include travel?
entry_period_selectorYes1 = single drawing period, 2 = multiple entry periods.
winner_drawing_timezoneNoDrawing timezone. Required when entry_period_selector = 1.
winner_notification_dateNoWinner notification date (YYYY-MM-DD). Required when entry_period_selector = 1.
winner_notification_timeNoWinner notification time. Required when entry_period_selector = 1.
sponsor_offering_multiplierNoIs sponsor offering entry multiplier? 1=Yes, 2=No. Default: 2.
winner_notification_timezoneNoWinner notification timezone. Required when entry_period_selector = 1.
sponsor_ecommerce_store_url_aNoEcommerce store URL. Required when method_of_entry = 5.
sponsor_ecommerce_store_url_bNoEcommerce store URL. Required when method_of_entry = 6.
sponsor_ecommerce_store_url_cNoEcommerce/subscription store URL. Required when method_of_entry = 8.
social_media_entry_descriptionNoSocial media entry details. Required when method_of_entry = 3.
sponsor_asking_to_submit_videoNoAsking for video submission? 1=Yes, 2=No. Default: 2.
limit_or_max_number_of_entries_amoeNoMax entries via AMOE (>= 1). Required when method_of_entry is 5, 6, 7, or 8.
sponsor_awarding_bonus_email_socialNoAwarding bonus for email/social? 1=Yes, 2=No. Default: 2.
total_number_of_entries_awarded_amoeNoTotal entries awarded via AMOE (>= 1). Required when method_of_entry is 5, 6, 7, or 8.
sponsor_donations_acceptance_page_urlNoDonations acceptance page URL. Required when method_of_entry = 7.
create_sweepstakesInspect

Create a new sweepstakes programmatically. Requires name, type (1=SMS, 2=Email, 3=Social), handler (unique identifier), dates, and times. CRITICAL: You MUST know the current date before creating a sweepstakes — never guess or assume. Start dates must be today or in the future. This is a billable operation that creates real production data. ALWAYS confirm with the user before creating. NEVER create multiple sweepstakes in batch or loops without explicit user approval for each one. If user requests bulk creation (e.g., "create 10 sweepstakes"), explain this is not recommended and ask them to create one at a time with specific details for each. LIMITS: Maximum 3 active sweepstakes and 10 total (active + inactive). Before creating, use fetch_sweepstakes to verify the account has not reached these limits. If limits are reached, refuse the operation and inform the user. Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
handlerYesUnique identifier (max 20 alphanumeric chars, auto-converted to uppercase)
end_dateYesEnd date in YYYY-MM-DD format (cannot precede start_date)
end_timeYesEnd time in HH:MM format 24-hour (default: 23:59)
start_dateYesStart date in YYYY-MM-DD format (must be today or future)
start_timeYesStart time in HH:MM format 24-hour (default: 00:00)
sweepstakes_nameYesUser-defined name for the sweepstakes
sweepstakes_typeYesSweepstakes type: 1 (SMS), 2 (Email), or 3 (Social). Default: 2 (Email)
delete_if_deletedNoAuto-delete related data when sweepstakes deleted (default: false)
sync_with_winnersNoSync with Winners app (default: false)
create_in_calendarNoCreate calendar event for this sweepstakes (default: false)
delete_if_acct_deletedNoDelete sweepstakes if account is deleted (default: false)
create_ticketInspect

Create a new support ticket with title, description, and priority level. FORMAT: Only these HTML tags are allowed in description: , , , , . NEVER insert scripts, iframes, event handlers (onclick, onerror, etc.), style tags, or any executable code. SPACING: Do NOT use   — it creates ugly blank blocks in the UI. Use for line breaks within text only.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesTicket subject/title (max 200 characters)
priorityYesPriority level: 1 (Low), 2 (Medium), 3 (High)
descriptionYesDetailed description of the issue (max 20,000 characters). Allowed HTML: <b>, <strong>, <i>, <hr>, <br>. No scripts, iframes, or executable code.
create_todoInspect

Create a new internal To-Do item. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only. FORMAT: Only these HTML tags are allowed in description: , , , , . NEVER insert scripts, iframes, event handlers (onclick, onerror, etc.), style tags, or any executable code. SPACING: Do NOT use   — it creates ugly blank blocks in the UI. Use for line breaks within text only.

ParametersJSON Schema
NameRequiredDescriptionDefault
pinNoPin this To-Do to the top. Default: false.
titleYesTo-Do title (max 200 characters).
deadlineNoDeadline date in ISO 8601 format (e.g. "2026-03-01").
priorityYesPriority level: 1 = Low, 2 = Medium, 3 = High.
descriptionNoDetailed description (max 20,000 characters). Allowed HTML: <b>, <strong>, <i>, <hr>, <br>. No scripts, iframes, or executable code.
resource_affectedNoResource affected (e.g. "renaissance", "api", "aws", "general"). Default: "general".
delete_calendar_eventInspect

Permanently delete a calendar event. Use fetch_calendar_events first to get the event_token. WARNING: This action cannot be undone.

ParametersJSON Schema
NameRequiredDescriptionDefault
event_tokenYesThe event token to delete (UUID format)
delete_groupInspect

Permanently delete a group from a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token, then fetch_groups to get the group_token. WARNING: Cannot delete primary groups, locked groups, or groups with participants.

ParametersJSON Schema
NameRequiredDescriptionDefault
group_tokenYesThe group token to delete (UUID format)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
delete_noteInspect

Permanently delete a note. Use fetch_notes first to get the note_token. WARNING: This action cannot be undone.

ParametersJSON Schema
NameRequiredDescriptionDefault
note_tokenYesThe note token to delete (UUID format)
delete_participantInspect

Permanently delete a participant from a sweepstakes. WARNING: This action cannot be undone. Use get_participant first to verify the participant details before deleting.

ParametersJSON Schema
NameRequiredDescriptionDefault
participant_tokenYesThe participant token to delete (UUID format)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
delete_ruleInspect

Permanently delete an official rules document from a sweepstakes. Use fetch_rules first to get the rules_token. WARNING: This action cannot be undone.

ParametersJSON Schema
NameRequiredDescriptionDefault
rules_tokenYesThe rules token to delete (UUID format)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
delete_scheduled_drawingInspect

Delete a pending scheduled drawing. Use fetch_scheduled_drawings first to get the schedule_token. WARNING: This action cannot be undone. Only drawings with pending status can be deleted — completed or errored drawings cannot be removed. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
schedule_tokenYesThe scheduled drawing token to delete (UUID format)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
delete_sweepstakesInspect

Permanently delete a sweepstakes and all associated data including participants, statistics, and automations. Use fetch_sweepstakes first to get the sweepstakes_token. CRITICAL: This is a DESTRUCTIVE operation that cannot be undone. ALWAYS ask for explicit user confirmation before deleting, showing the sweepstakes name. NEVER delete multiple sweepstakes in batch or loops. If user requests bulk deletion, refuse and ask them to delete one at a time after reviewing each.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe unique identifier (token) of the sweepstakes to delete
delete_ticketInspect

Permanently delete an open support ticket. Use fetch_open_tickets first to get the case_id. WARNING: This action cannot be undone. Only open tickets can be deleted.

ParametersJSON Schema
NameRequiredDescriptionDefault
case_idYesThe case number of the ticket to delete
draw_winnersInspect

Draw winners from a sweepstakes immediately. Use fetch_sweepstakes first to get the sweepstakes_token, and fetch_groups to get available groups. CRITICAL: This is a production operation that selects real winners. ALWAYS confirm with the user before drawing — including the number of winners and which group to draw from. Uses weighted random selection favoring participants with bonus entries. Cannot draw from paused or archived sweepstakes. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (names, emails).

ParametersJSON Schema
NameRequiredDescriptionDefault
groupYesGroup token to draw from, or "allgroups" for all participants
exclude_spamNoExclude flagged spam participants (default: true)
how_many_winnersYesNumber of winners to pick (must be >= 1)
completed_entriesNoOnly include participants with completed entries (default: true)
include_opted_outNoInclude participants who opted out (default: false)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
fetch_areacodesInspect

Search US telephone area codes by code number or state name. Returns up to 10 results. Omit search to get all area codes.

ParametersJSON Schema
NameRequiredDescriptionDefault
searchNoSearch term: area code number or state name (optional, omit to get all)
fetch_billing_consumptionsInspect

Get monthly and yearly billing consumption totals for your account. Shows aggregated usage data from billing transactions and data transfers.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_billing_transactionsInspect

Get all billing transactions for your account including invoices, amounts, and status. Results are sorted by creation date (newest first).

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_calendar_eventsInspect

Get all calendar events for your account. Returns events with their details including dates, times, location, and status. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (titles, dates, times, locations).

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_closed_ticketsInspect

Get closed/resolved support tickets with pagination (20 per page) and search. Returns summary info only — use get_ticket with the case number to get full ticket details including notes, files, and collaborators. Supports filtering by subject/description text, platform (renaissance, api, general, overture, winners), and priority (1=Low, 2=Medium, 3=High). DISPLAY RULE: NEVER show tokens (UUIDs) to the user.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1, 20 tickets per page)
searchNoSearch by subject or description (case-insensitive)
platformNoFilter by platform: renaissance, api, general, overture, winners
priorityNoFilter by priority: 1 (Low), 2 (Medium), 3 (High)
fetch_countriesInspect

Search countries by name, international dial code, or ISO abbreviation. Returns up to 10 results with English/Spanish names. Omit search to get all countries.

ParametersJSON Schema
NameRequiredDescriptionDefault
searchNoSearch term: country name, dial code (e.g. "+34"), or ISO code (e.g. "US") (optional, omit to get all)
fetch_data_transferInspect

Get data transfer records for a specific sweepstakes including bytes transferred, payment status, and rates. Use fetch_sweepstakes first to get the sweepstakes_token.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token to fetch data transfer records from (UUID format)
fetch_documentationInspect

Get help and support documentation articles. Supports pagination and search by title or content. Returns up to 10 documents per page.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number to retrieve (default: 1)
limitNoNumber of documents per page, max 10 (default: 5)
searchNoSearch term to filter documents by title or content
fetch_groupsInspect

Get all groups from a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. Groups are used to organize and segment participants. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (group names, statuses).

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token (UUID format)
fetch_notesInspect

Get all notes for your account. Notes are automatically decrypted and returned in reverse chronological order. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (titles, content, dates).

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_open_ticketsInspect

Get open support tickets with pagination (20 per page) and search. Returns summary info only — use get_ticket with the case number to get full ticket details including notes, files, and collaborators. Supports filtering by subject/description text, platform (renaissance, api, general, overture, winners), and priority (1=Low, 2=Medium, 3=High). DISPLAY RULE: NEVER show tokens (UUIDs) to the user.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1, 20 tickets per page)
searchNoSearch by subject or description (case-insensitive)
platformNoFilter by platform: renaissance, api, general, overture, winners
priorityNoFilter by priority: 1 (Low), 2 (Medium), 3 (High)
fetch_participantsInspect

Get a paginated list of participants from a sweepstakes (20 per page). Use fetch_sweepstakes first to get the sweepstakes_token. Supports search by name, email, or phone, and filtering by opt-in date or date range. Results are sorted by creation date (newest first). For full participant details, use get_participant with a specific email, phone, or token. NEVER fabricate or hallucinate participant data — only report what the API returns. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (names, emails, phones, dates).

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1, 20 results per page)
searchNoSearch by first name, last name, email, or phone number (case-insensitive)
end_dateNoEnd of date range filter (YYYY-MM-DD, requires start_date)
start_dateNoStart of date range filter (YYYY-MM-DD, requires end_date)
opt_in_dateNoFilter by specific opt-in date (YYYY-MM-DD)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
fetch_rulesInspect

Get all official rules for a sweepstakes including primary and secondary rules. Use fetch_sweepstakes first to get the sweepstakes_token.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token to fetch rules from (UUID format)
fetch_scheduled_drawingsInspect

Get all scheduled drawings for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. Returns all scheduled drawings regardless of status, sorted by creation date (newest first). DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (dates, times, status, winner counts).

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token (UUID format)
fetch_statesInspect

Get all US states including DC, Puerto Rico, and US territories. Returns full names and two-letter abbreviations.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_sweepstakesInspect

Get all sweepstakes associated with your account. Returns a list of all sweepstakes with their details. DISPLAY RULE: NEVER show tokens (UUIDs) to the user — not sweepstakes tokens, user tokens, participant tokens, or any internal identifiers. Use tokens internally for tool chaining but present only human-readable information (names, dates, statuses) to the user.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_timezonesInspect

Get all available timezones with IANA identifiers, abbreviations, and UTC offsets. Use this tool whenever a timezone needs to be determined for any operation. DEFAULT: If the correct timezone cannot be determined, always use TimezoneId 7 (Eastern Standard Time - America/New_York).

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_todosInspect

Get all To-Do items with pagination (20 per page), search, and advanced filters. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (default: 1, 20 items per page).
yearNoFilter by creation year (ignored if date_from/date_to provided).
monthNoFilter by creation month 1-12 (requires year parameter).
pinnedNoFilter pinned items only when true.
searchNoSearch by title or description (case-insensitive).
statusNoFilter by status: "pending" or "completed".
date_toNoEnd date filter in ISO 8601 format (e.g. "2026-12-31").
priorityNoFilter by priority: 1 = Low, 2 = Medium, 3 = High.
resourceNoFilter by resource affected (e.g. "renaissance", "api", "aws", "general").
date_fromNoStart date filter in ISO 8601 format (e.g. "2026-01-01").
fetch_wallet_transactionsInspect

Get all wallet transactions for your account including credits, debits, and payment details.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

fetch_winnersInspect

Get winners from a sweepstakes with pagination. Use fetch_sweepstakes first to get the sweepstakes_token. Winners are sorted by draw date (most recent first). Supports search by email or phone. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information (names, emails, draw dates).

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1)
searchNoSearch filter for email or phone number (optional)
items_per_pageNoResults per page (default: 10)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
fetch_zipcodesInspect

Search US zip codes by zip code, city, or state name. Returns up to 10 results with city and state details.

ParametersJSON Schema
NameRequiredDescriptionDefault
searchYesSearch term: zip code, city name, or state name (case-insensitive)
get_businessInspect

Get business information for a Sweeppea account. Returns company details, address, and business settings.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

get_calendar_eventInspect

Get a single calendar event by its token. Use fetch_calendar_events first to get event tokens.

ParametersJSON Schema
NameRequiredDescriptionDefault
event_tokenYesThe event token (UUID format)
get_entry_fieldsInspect

Get all form fields for a sweepstakes entry page. Use fetch_sweepstakes first to get the sweepstakes_token. Call this before add_participant to discover required fields. Returns field names, types, and whether they are required.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token (UUID format)
get_entry_settingsInspect

Get entry page settings for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. Returns all configuration: display, colors, spacing, entry settings, compliance, confirmation page, winners page, age gate, AMOE, geolocation, analytics, social media follows, sharing rewards, bonus entries, and sponsor profiles. Use this before update_entry_settings to see current values. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe sweepstakes token (UUID format)
get_noteInspect

Fetch a single note by its token. Use fetch_notes first to get the note_token. The note content is automatically decrypted in the response. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
note_tokenYesThe unique token (UUID) of the note to retrieve
get_participantInspect

Fetch full details of a single participant from a sweepstakes by token, email, or phone. At least one search parameter is required. Use fetch_sweepstakes first to get the sweepstakes_token. For listing participants, use fetch_participants instead. NEVER fabricate, invent, or hallucinate participant data under any circumstance. If no result is returned by the API, report exactly that — do not guess names, emails, or counts. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
emailNoParticipant email address - use this OR participant_token OR phone
phoneNoParticipant phone number (10 digits) - use this OR participant_token OR email
participant_tokenNoThe participant token (UUID format) - use this OR email OR phone
sweepstakes_tokenYesThe sweepstakes token (UUID format)
get_planInspect

Get plan details for a Sweeppea subscription. Returns pricing, limits, features, and usage information.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

get_profileInspect

Get user profile information for a Sweeppea account. Returns user details like name, email, and account settings.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

get_ticketInspect

Get full details of a support ticket by case number. Use fetch_open_tickets or fetch_closed_tickets first to find tickets, then use this tool with the case number to get complete information including notes, files, collaborators, and statistics. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Present only human-readable information (case number, subject, dates, notes).

ParametersJSON Schema
NameRequiredDescriptionDefault
case_numberYesThe ticket case number (e.g., "HYXTNJV")
health_checkInspect

Verify connection to Sweeppea API and validate your API key. Use this to test if your credentials are working correctly.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

hello_worldInspect

Returns a simple Hello World greeting message

ParametersJSON Schema
NameRequiredDescriptionDefault
nameNoName to include in greeting (optional)
pause_sweepstakesInspect

Pause a sweepstakes, setting it to inactive status while preserving all data. Use fetch_sweepstakes first to get the sweepstakes_token. Participants will not be able to enter while paused.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe unique identifier (token) of the sweepstakes to pause
resolve_ticketInspect

Close/resolve an open support ticket. Use fetch_open_tickets first to get the case_id.

ParametersJSON Schema
NameRequiredDescriptionDefault
case_idYesThe case number of the ticket to close (e.g., "ABC1234")
schedule_drawingInspect

Schedule a future winner drawing for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token, and fetch_groups for group tokens. CRITICAL: This is a production operation. ALWAYS confirm with the user before scheduling. Requires at least one eligible participant. Winner count cannot exceed available participants. DISPLAY RULE: NEVER show tokens (UUIDs) to the user. Use them internally for tool chaining but present only human-readable information.

ParametersJSON Schema
NameRequiredDescriptionDefault
groupYesGroup token or "allgroups" for all participants
messageNoWinner notification message (used when selected_action = 2)
end_dateYesDrawing date or period end date (YYYY-MM-DD)
end_timeYesTime in HH:mm format (24-hour)
timezoneYesTimezone ID (use fetch_timezones to get valid IDs, default: 7 = Eastern)
frequencyNoFrequency: 0=None, 1=Hourly, 2=Daily, 3=Weekly, 4=Monthly (default: 0)
exclude_spamNoExclude spam-flagged participants (default: true)
delivery_timeNoDelivery time for settime mode (HH:mm)
schedule_modeYesMode: "schedule" for specific date/time, "settime" for time period
add_to_calendarNoAdd drawing to calendar (default: false)
day_of_the_weekNoDay of week: 1=Sunday through 7=Saturday (for weekly/monthly frequency)
selected_actionYesAction: 1 = Draw Winners only, 2 = Draw Winners & Notify
send_copy_to_meNoEmail notification to account owner (default: false)
how_many_winnersYesNumber of winners to pick (must be >= 1)
include_opted_outNoInclude opted-out participants (default: false)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
week_of_the_monthNoWeek of month: 1-4 (for monthly frequency)
publish_to_winners_pageNoPublish winners to public winners page (default: false)
unpause_sweepstakesInspect

Reactivate a paused sweepstakes, allowing participants to enter again. Use fetch_sweepstakes first to get the sweepstakes_token.

ParametersJSON Schema
NameRequiredDescriptionDefault
sweepstakes_tokenYesThe unique identifier (token) of the sweepstakes to unpause
update_calendar_eventInspect

Update an existing calendar event. Use fetch_calendar_events first to get the event_token. Supports partial updates - only provide fields you want to change. Note: Cannot update events to past dates.

ParametersJSON Schema
NameRequiredDescriptionDefault
colorNoNew event color in hex format (optional)
titleNoNew event title (optional)
statusNoNew event status (optional)
all_dayNoWhether this is an all-day event (optional)
end_dateNoNew end date in ISO 8601 format (optional)
end_timeNoNew end time in HH:MM format (optional)
latitudeNoNew location latitude coordinate (optional)
locationNoNew event location (optional)
completedNoMark event as completed (optional)
event_urlNoNew URL associated with the event (optional)
longitudeNoNew location longitude coordinate (optional)
start_dateNoNew start date in ISO 8601 format (optional)
start_timeNoNew start time in HH:MM format (optional)
descriptionNoNew event description (optional)
event_tokenYesThe event token to update (UUID format, required)
notificationNoNew notification settings (optional)
private_eventNoWhether this is a private event (optional)
people_involvedNoNew people involved in the event (optional)
sms_notificationNoEnable SMS notifications (optional)
repeat_this_eventNoNew repeat configuration (optional)
update_entry_settingsInspect

Update entry page settings for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token, and get_entry_settings to see current values before updating. LIMIT: You can update between 1 and 5 fields per request. If the user needs to update more than 5 fields, break the updates into multiple requests of up to 5 fields each. Inform the user about this limit. ALLOWED FIELDS: EntryPageHeadline, EntryPageDescription, EntryPageAbbreviatedRules, EntryPageWidth, EntryPageWidthMeasure, EntryPageBorder, EntryPageRadius, EntryPageBackgroundColor, EntryPageBackgroundInnerColor, EntryPageTextColor, EntryPageButtonColor, EntryPageMarginTop, EntryPageMarginBottom, EntryPageShowOverlay, BonusEntriesSwitch, BonusEntriesValue, EmailOptInSwitch, EmailOptInMessage, SMSTextOptInSwitch, TermsConditionsSwitch, TermsConditionsMessage, SelectedOfficialRules, ReCaptcha, ConfirmationPageHeadline, ConfirmationPageDescription, WebExpirationMessage, ExternalConfirmationPageURI, ConfirmationYoutubeUrl, ActivateWinnersSwitch, WinnersPageHeadline, WinnersPageDescription, ExternalWinnersPageURI, ActivateAgeGateSwitch, AgeGateHeadline, AgeGateDescription, AgeGateMinAge, AgeGateBackgroundColor, AgeGateTextColor, ActivateAmoeSwitch, AmoeHeadline, AmoeDescription, AmoeEntries, EnableInternationalAMOEForm, GeoLocation, GeoLocationIsRequiredToRenderPage, AllowParticipantsWithinFences, CollectStatistics, EnableShareWidget, EnableProgressBar, EnableSweepstakesCountdown, EnableNumberOfParticipants, EnableSocialWidget, FollowFacebookSwitch, FollowXSwitch, FollowInstagramSwitch, FollowTikTokSwitch, FollowLinkedInSwitch, FollowPinterestSwitch, FollowThreadsSwitch, FollowRedditSwitch, FollowSnapchatSwitch, FollowYoutubeSwitch, FollowTwitchSwitch, BothSocialShareParticipantsAwardedSwitch, BothEmailShareParticipantsAwardedSwitch, BonusEntriesOnRegister, BonusEntriesOnShareFacebook, BonusEntriesOnShareX, BonusEntriesOnShareInstagram, BonusEntriesOnShareTikTok, BonusEntriesOnShareLinkedIn, BonusEntriesOnSharePinterest, BonusEntriesOnShareThreads, BonusEntriesOnShareReddit, BonusEntriesOnShareSnapchat, BonusEntriesOnShareWhatsApp, BonusEntriesOnShareTelegram, BonusEntriesOnShareGenericLink, BonusEntriesOnShareEmail, BonusEntriesFollowFacebook, BonusEntriesFollowX, BonusEntriesFollowInstagram, BonusEntriesFollowTikTok, BonusEntriesFollowLinkedIn, BonusEntriesFollowPinterest, BonusEntriesFollowThreads, BonusEntriesFollowReddit, BonusEntriesFollowSnapchat, BonusEntriesFollowYoutube, BonusEntriesFollowTwitch, SponsorFacebookProfile, SponsorXProfile, SponsorInstagramProfile, SponsorTikTokProfile, SponsorLinkedInProfile, SponsorPinterestProfile, SponsorThreadsProfile, SponsorRedditProfile, SponsorSnapchatProfile, SponsorYoutubeProfile, SponsorTwitchProfile. COLOR FIELDS: EntryPageBackgroundColor, EntryPageBackgroundInnerColor, EntryPageTextColor, EntryPageButtonColor use format { "hexa": "#RRGGBB" }. AgeGateBackgroundColor, AgeGateTextColor use format { "hex": "#RRGGBB" }. EntryPageWidthMeasure only accepts "%" or "px". DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
settingsYesObject with 1 to 5 settings fields to update. Field names must be PascalCase as listed in the tool description. Example: { "EntryPageHeadline": "Win Big!", "BonusEntriesSwitch": true }
sweepstakes_tokenYesThe sweepstakes token (UUID format)
update_groupInspect

Update the name of an existing group within a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token, then fetch_groups to get the group_token.

ParametersJSON Schema
NameRequiredDescriptionDefault
group_nameYesThe new name for the group (must be unique within the sweepstakes)
group_tokenYesThe group token to update (UUID format)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
update_noteInspect

Update an existing note. Use fetch_notes first to get the note_token. Supports partial updates - only provide the fields you want to change. FORMAT: Only these HTML tags are allowed: , , , , , , , , , , , , , . NEVER insert scripts, iframes, event handlers (onclick, onerror, etc.), style tags, or any executable code. SPACING: Do NOT use   between sections — it creates ugly blank blocks in the UI. Instead, rely on natural HTML block element spacing. Place content directly inside tags: TitleTextItem. Only use inside a tag when you need a line break within a paragraph.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleNoNew title (max 100 characters, must be unique)
pinnedNoPin or unpin the note
contentNoNew content (max 100,000 characters, will be encrypted). Allowed HTML: <h1>-<h6>, <p>, <a>, <br>, <strong>, <i>, <ul>, <ol>, <li>. No scripts, iframes, or executable code.
note_tokenYesThe note token to update (UUID format)
update_ruleInspect

Update an existing official rules document. Use fetch_rules first to get the rules_token. UPDATABLE FIELDS: Only these fields can be modified: title, document_content, abbreviated_rules_shopify. NOT UPDATABLE: sweepstakes association, primary status, creation date, and any other field NOT listed above cannot be changed after creation. Do NOT tell the user they can update fields that are not supported by this endpoint. If they ask to change something not updatable, explain it cannot be modified after creation. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleNoNew title for the rules document (max 100 characters)
rules_tokenYesThe rules token to update (UUID format)
document_contentNoNew HTML content for the rules (max 1,000,000 characters)
sweepstakes_tokenYesThe sweepstakes token (UUID format)
abbreviated_rules_shopifyNoAbbreviated rules for Shopify integration (max 1,000,000 characters)
update_sweepstakesInspect

Update an existing sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. UPDATABLE FIELDS: Only these fields can be modified: sweepstakes_name, start_date, end_date, start_time, end_time. NOT UPDATABLE: handler, sweepstakes_type, calendar settings, sync options, and any other field NOT listed above cannot be changed after creation. Do NOT tell the user they can update fields that are not supported by this endpoint. If they ask to change something not updatable, explain it cannot be modified after creation. DISPLAY RULE: Never display tokens (UUIDs) to the user — use them internally only.

ParametersJSON Schema
NameRequiredDescriptionDefault
end_dateNoNew end date in YYYY-MM-DD format (cannot precede start_date)
end_timeNoNew end time in HH:MM format 24-hour
start_dateNoNew start date in YYYY-MM-DD format (must be today or future)
start_timeNoNew start time in HH:MM format 24-hour
sweepstakes_nameNoNew name for the sweepstakes (max 200 characters)
sweepstakes_tokenYesThe unique token (UUID) of the sweepstakes to update
update_ticketInspect

Update an open support ticket. Use fetch_open_tickets first to get the case_id. Only open tickets can be updated. FORMAT: Only these HTML tags are allowed in description: , , , , . NEVER insert scripts, iframes, event handlers (onclick, onerror, etc.), style tags, or any executable code. SPACING: Do NOT use   — it creates ugly blank blocks in the UI. Use for line breaks within text only.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleNoNew ticket subject (max 200 characters)
case_idYesThe case number of the ticket to update
descriptionNoNew ticket description (max 20,000 characters). Allowed HTML: <b>, <strong>, <i>, <hr>, <br>. No scripts, iframes, or executable code.

Discussions

No comments yet. Be the first to start the discussion!

Try in Browser

Your Connectors

Sign in to create a connector for this server.