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.

If you are the author of this connector, you can claim ownership by verifying the domain or GitHub account it belongs to. Claimed connector authors can inspect health checks, view analytics, and manage their listing.
Status
Healthy
Uptime
100.0% over the last 24 hours
Last Tested
Transport
Streamable HTTP · MCP 2025-11-25
URL
ChatGPT
–
Claude
–

TDQS

A3.8/5.0

Scored across 116 tools

Disambiguation4/5

Tools are largely distinct by resource+action, and descriptions go to great lengths to delineate near-neighbors (create_rule vs create_rules_wizard, fetch_codes vs fetch_code_stats vs get_code, fetch_survey_report vs fetch_survey_responses, pause_campaign vs pause_drip). A few pairs still require careful reading (get_entry_settings vs fetch_sweepstakes include_settings, get_code_settings vs update_code_settings), but no true duplicates exist.

Naming Consistency4/5

Overwhelmingly consistent snake_case verb_noun (fetch_*, get_*, create_*, update_*, delete_*, pause_/resume_/cancel_*), with the fetch_=list / get_=single convention applied fairly reliably. Minor deviations: hello_world/health_check are non-CRUD utility names and a couple of domains mix verbs (add_participant, draw_winners, redeem_code) without breaking readability.

Tool Count2/5

116 tools is very heavy even for a broad platform spanning sweepstakes, participants, rules, codes, surveys, drips, campaigns, invoices, files, notes, todos, tickets and billing. Each domain is individually reasonable, but the aggregate surface is bloated and imposes high selection cost on the agent.

Completeness4/5

Coverage is deep: CRUD plus lifecycle and reporting across nearly every domain, with explicit handling of modules, limits and state machines. Gaps exist (no campaign or drip creation, no template/sender endpoints), but they are documented as deliberate API boundaries rather than oversights, and workarounds are pointed out.

Available Tools

116 tools
add_participantAInspect

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. Both email AND phone are required — the Sweeppea API rejects an entry missing either one. 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. Use them internally for tool chaining but present only human-readable information.

add_participant

When to use

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. Both email AND phone are required — the Sweeppea API rejects an entry missing either one. 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. Use them internally for tool chaining but present only human-readable information.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

  2. get_entry_fields(sweepstakes_token) — discover required custom fields, their max_length, and (for list fields) the exact text in options

  3. Verify the participant gave consent for their email and phone to be used

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • email (string, required) — Participant email address (used as KeyEmail)

  • phone (string, required) — Participant phone number (used as KeyPhoneNumber). REQUIRED — the API rejects entries without it. Digits only for US numbers (e.g., "5551234567")

  • fields (object, required) — Form fields object. Keys must use underscores for spaces (e.g., {"First_Name": "John", "Last_Name": "Doe"})

  • bonus_entries (number, optional) — Number of bonus entries (optional, default: 0)

Notes

  • Both email and phone are required — the API rejects an entry missing either one with a misleading "maximum field length" error

  • Field keys use underscores instead of spaces (e.g. "First Name" → First_Name)

  • For US phones: strip non-digits before sending (e.g. "(555) 123-4567" → "5551234567")

  • Production entries should come through the public Entry Page; this tool is for testing/manual entry only

Inputs: email (required), phone (required), fields (required), sweepstakes_token (required), +1 more.

add_suppressionsA
Idempotent
Inspect

Add up to 500 addresses of ONE channel to the account do-not-contact list. Idempotent, and it never downgrades an existing opt-out. This is the safe direction — suppressing costs nothing and protects the account, so no confirmation is required. The response separates Added from AlreadySuppressed and Invalid; report those counts rather than claiming every address was added. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.

Inputs: channel (required), addresses (required).

assign_codeAInspect

Assign one available code to one named participant (regular or AMOE) of the SAME sweepstakes who holds no code yet. The code must be unassigned and not redeemed. This does not notify anyone — use send_code afterwards if the participant should receive it. Known API quirk: the echoed code comes back with AssignedTo null even when the assignment succeeded; do NOT report that field as the recipient — re-read with fetch_codes, which returns it correctly. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: coupon_token (required), participant_token (required).

cancel_campaignA
Destructive
Inspect

Cancel a campaign that has not finished and release the monthly allowance it was holding. CANNOT BE UNDONE — a cancelled campaign cannot be resumed, and messages already sent stay sent. confirm=true is REQUIRED. If the user only wants to stop it for now, use pause_campaign instead, which keeps the allowance and allows a resume — always offer that alternative first. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.

Inputs: confirm (required), campaign_token (required).

clone_sweepstakesAInspect

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: Each account has a per-plan cap on total sweepstakes (no separate active/total distinction). Before cloning, call get_plan to know the user's actual MaxSweepstakesAllowed, then fetch_sweepstakes to count current usage. If the user is at or near the cap, warn them before proceeding (e.g., "you have 9 of 10 sweepstakes allowed by your plan"). Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. Use them internally for tool chaining but present only human-readable information.

clone_sweepstakes

When to use

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: Each account has a per-plan cap on total sweepstakes (no separate active/total distinction). Before cloning, call get_plan to know the user's actual MaxSweepstakesAllowed, then fetch_sweepstakes to count current usage. If the user is at or near the cap, warn them before proceeding (e.g., "you have 9 of 10 sweepstakes allowed by your plan"). Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. Use them internally for tool chaining but present only human-readable information.

Parameters to validate before calling

  • handler (string, required) — The identifier (handler) of the original sweepstakes to clone

  • handler_new (string, required) — The unique identifier (handler) for the newly created sweepstakes

  • sweepstakes_name (string, required) — Display name for the cloned sweepstakes

  • start_date (string, required) — Start date in YYYY-MM-DD format

  • end_date (string, required) — End date in YYYY-MM-DD format

  • start_time (string, required) — Start time in HH:MM format (24-hour)

  • end_time (string, required) — End time in HH:MM format (24-hour)

Inputs: handler (required), end_date (required), end_time (required), start_date (required), +3 more.

count_participantsA
Read-onlyIdempotent
Inspect

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.

count_participants

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • filter_type (string, optional) — one of: all, participants, amoe, optouts — Filter type: all (default), participants, amoe (alternate method of entry), or optouts

  • start_date (string, optional) — Start date filter (ISO 8601 format, e.g., 2025-01-01)

  • end_date (string, optional) — End date filter (ISO 8601 format, e.g., 2025-12-31)

Inputs: sweepstakes_token (required), end_date, start_date, filter_type.

create_calendar_eventAInspect

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.

create_calendar_event

When to use

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.

Parameters to validate before calling

  • title (string, required) — Event title (required)

  • start_date (string, required) — Start date in ISO 8601 format, e.g., 2026-01-20 (required)

  • end_date (string, required) — End date in ISO 8601 format, e.g., 2026-01-20 (required)

  • description (string, optional) — Event description (optional)

  • location (string, optional) — Event location (optional)

  • start_time (string, optional) — Start time in HH:MM format, e.g., 09:00 (optional)

  • end_time (string, optional) — End time in HH:MM format, e.g., 17:00 (optional)

  • color (string, optional) — Event color in hex format, e.g., #FF5733 (optional)

  • all_day (boolean, optional) — Whether this is an all-day event (optional, default: false)

  • status (string, optional) — Event status (optional)

  • private_event (boolean, optional) — Whether this is a private event (optional, default: false)

  • sms_notification (boolean, optional) — Enable SMS notifications (optional, default: false)

  • completed (boolean, optional) — Mark event as completed (optional, default: false)

  • latitude (number, optional) — Location latitude coordinate (optional)

  • longitude (number, optional) — Location longitude coordinate (optional)

  • event_url (string, optional) — URL associated with the event (optional)

  • people_involved (string, optional) — People involved in the event (optional)

  • repeat_this_event (string, optional) — Repeat configuration for recurring events (optional)

  • notification (string, optional) — Notification settings (optional)

Notes

  • Calendar API uses UTC — today's date may be rejected as past depending on the user's timezone

  • Always use tomorrow or later when creating events

  • If the user asks for today, explain the UTC limitation

Inputs: title (required), end_date (required), start_date (required), color, +15 more.

create_codesAInspect

Add 1 to 1,000 codes you ALREADY have — from a POS, a CRM or a printed batch — to a sweepstakes, with attributes shared by all of them. To have Sweeppea invent the codes for you, use generate_codes instead. Codes are up to 20 letters, digits, - or _; whitespace is stripped; they are matched exactly and case-sensitively. The response reports Duplicates and Invalid separately from Created — always tell the user those counts rather than claiming every code landed. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: codes (required), sweepstakes_token (required), value, description, +3 more.

create_groupAInspect

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

create_group

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • group_name (string, required) — The name of the group (must be unique within the sweepstakes)

Inputs: group_name (required), sweepstakes_token (required).

create_invoiceAInspect

Create a new invoice. Requires the Invoices module enabled on the account (disabled by default) — if the API returns 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support to request access. Subtotal, TaxAmount and Total are ALWAYS computed server-side from items, discount_amount and tax_rate — never calculate or promise totals yourself; report what the API returns. The computed total must be between $1 and $1,000,000. Creating an invoice NEVER notifies the recipient automatically — sharing the PublicLink is up to the user. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs to the user; the PublicLink URL and InvoiceNumber ARE meant to be shared.

create_invoice

When to use

Create a new invoice. Requires the Invoices module enabled on the account (disabled by default) — if the API returns 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support to request access. Subtotal, TaxAmount and Total are ALWAYS computed server-side from items, discount_amount and tax_rate — never calculate or promise totals yourself; report what the API returns. The computed total must be between $1 and $1,000,000. Creating an invoice NEVER notifies the recipient automatically — sharing the PublicLink is up to the user. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs to the user; the PublicLink URL and InvoiceNumber ARE meant to be shared.

Parameters to validate before calling

  • bill_to (object, required) — Recipient object with PascalCase keys exactly as the API expects: {"Name": "...", "Email": "..."} required; optional keys: Company, Phone, Address, City, State, ZipCode, Country, TaxId

  • items (array, required) — Line items array (min 1, max 60) with PascalCase keys: [{"Description": "..." (required), "Quantity": number (max 100), "Rate": number (max 1000000)}]. Amount per line is computed server-side

  • title (string, optional) — Invoice title/concept (max 200 characters, optional)

  • issue_date (string, optional) — Issue date in ISO format YYYY-MM-DD (optional, defaults to today)

  • due_date (string, optional) — Due date in ISO format YYYY-MM-DD (optional, defaults to account setting)

  • discount_amount (number, optional) — Flat discount amount, capped at the subtotal (optional)

  • tax_enabled (boolean, optional) — Apply tax to the invoice (optional, default false)

  • tax_label (string, optional) — Tax label shown on the invoice (optional, default "Tax")

  • tax_rate (number, optional) — range: 0–100 — Tax percentage 0-100 (optional)

  • payment_method (string, optional) — one of: card, check, transfer — Payment method (optional, default "card")

  • payment_instructions (string, optional) — Offline payment instructions — only for "check" or "transfer" methods (optional)

  • notes_to_recipient (string, optional) — Notes shown to the recipient (max 3000 characters, optional)

  • terms (string, optional) — Terms and conditions text (max 3000 characters, optional)

  • status (string, optional) — one of: draft, pending — Initial status (optional, default "draft"). "pending" publishes immediately

Notes

  • Requires the Invoices module enabled on the account — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support

  • Subtotal, TaxAmount and Total are computed server-side from Items, DiscountAmount and TaxRate — never calculate totals yourself; report what the API returns

  • Computed total must be between $1 and $1,000,000; max 60 line items

  • Creating an invoice NEVER notifies the recipient — sharing the PublicLink is up to the user

Inputs: items (required), bill_to (required), terms, title, +10 more.

create_noteAInspect

Create a new note. Content is encrypted (AES-256-CBC). HTML tags: h1-h6, p, a, br, strong, i, ul, ol, li. No scripts/iframes. Do NOT use   between sections.

create_note

When to use

Create a new note. Content is encrypted (AES-256-CBC). HTML tags: h1-h6, p, a, br, strong, i, ul, ol, li. No scripts/iframes. Do NOT use   between sections.

Parameters to validate before calling

  • title (string, required) — Note title (max 100 characters, must be unique)

  • content (string, required) — Note content (max 100,000 characters, will be encrypted). Allowed HTML: -, , , , , , , , . No scripts, iframes, or executable code.

  • pinned (boolean, optional) — Pin note to top of list (default: false)

Notes

  • Content is encrypted with AES-256-CBC

  • Do NOT put sensitive data in the title field — titles are not encrypted

  • Allowed HTML tags in content: h1-h6, p, a, br, strong, i, ul, ol, li

  • Do NOT use   between sections — relies on natural HTML block spacing

Inputs: title (required), content (required), pinned.

create_ruleAInspect

Create a new official rules document for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. LEGAL BYPASS WARNING: This tool publishes a free-form document WITHOUT the legal safeguards of create_rules_wizard (AMOE enforcement, 21+ alcohol gate, COPPA, state eligibility clauses). ALWAYS prefer create_rules_wizard, which generates certified legal templates server-side. Use this tool ONLY when the user already has a complete, professionally reviewed rules document. NEVER compose, draft, or modify the legal language yourself. Require explicit user confirmation before publishing — exactly as with delete_* tools — and confirm the document was prepared or reviewed by the user or their counsel. 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.

create_rule

When to use

Create a new official rules document for a sweepstakes. Use fetch_sweepstakes first to get the sweepstakes_token. LEGAL BYPASS WARNING: This tool publishes a free-form document WITHOUT the legal safeguards of create_rules_wizard (AMOE enforcement, 21+ alcohol gate, COPPA, state eligibility clauses). ALWAYS prefer create_rules_wizard, which generates certified legal templates server-side. Use this tool ONLY when the user already has a complete, professionally reviewed rules document. NEVER compose, draft, or modify the legal language yourself. Require explicit user confirmation before publishing — exactly as with delete_* tools — and confirm the document was prepared or reviewed by the user or their counsel. 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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

  2. fetch_rules(sweepstakes_token) — if primary rules exist, WARN that the new one will be SECONDARY

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • title (string, required) — Title of the official rules document (max 100 characters)

  • document_content (string, required) — Full HTML content of the official rules (max 1,000,000 characters)

Notes

  • Prefer create_rules_wizard for legal-grade Official Rules

  • Use this only when you have a fully prepared HTML document and the wizard does not apply

  • This tool bypasses the wizard safeguards (AMOE, 21+ alcohol gate, COPPA, state eligibility) — require explicit user confirmation before publishing, like delete_* tools, and confirm the document was prepared or reviewed by the user or their counsel

  • NEVER compose or modify the legal language yourself

Inputs: title (required), document_content (required), sweepstakes_token (required).

create_rules_wizardAInspect

Generate official sweepstakes rules via the 14-step wizard. BEFORE CALLING: 1) fetch_sweepstakes to get token, dates, name. 2) get_business + get_profile to pre-fill sponsor fields. 3) fetch_rules to check for existing primary rules — if primary exists, warn user new rules will be SECONDARY. Ask wizard questions in order (steps A-N), one at a time or in small groups. Only ask for data you cannot get from API calls. PRIMARY RULES LINK: If result is_primary=true, give user the URL: https://swpp.me/r/[handler] (handler in lowercase from fetch_sweepstakes). RULES LANGUAGE: Always set rules_language="en". The wizard generates ALL legal text server-side — NEVER compose rules language yourself. AMOE URL: The AMOE URL is NOT the entry page URL — the wizard handles AMOE language automatically based on method_of_entry. AGE GATE: Only activate Age Gate when min_age=2 (21+). NEVER for min_age=1 (18+) or min_age=3 (13+). AGE-RESTRICTED PRODUCTS: two independent 21+ triggers. Alcohol (alcohol_sweeps=1) applies only when the SPONSOR produces or manufactures alcohol — a retailer that merely sells it is 2. Tobacco, nicotine and vaping (nicotine_tobacco_sweeps=1) has NO such distinction: federal Tobacco 21 sets 21 for every tobacco and nicotine product, whoever sponsors it. Do not apply the producer/retailer reasoning to a vape or tobacco promotion — it is 21+ either way. Either trigger requires min_age=2. A nicotine promotion additionally needs states=4 with Massachusetts, Michigan and Virginia left out (those three prohibit tobacco sweepstakes), and the prize may never be the product itself — a discount or a coupon redeemed at a paid age-verified purchase is the permitted shape. SPONSOR DATA: every sponsor field is published verbatim in a public legal document. Take it from the user or from get_business for THIS promotion — never from an earlier conversation, another sweepstakes, or your own memory — show the complete block to the user, get their approval, and only then set sponsor_data_confirmed: true. If a value is missing, ask; never fill it with a plausible guess, and never use a placeholder domain (example.com, .example, .test) in any URL. REGISTRATION AND BONDING: prizes with an ARV over USD 5,000 require registration and a surety bond in Florida and New York (Rhode Island adds a registration requirement of its own for retail promotions). Always name the USD 5,000 threshold AND all three states when the prize value is near or above it, and offer the states values that exclude them: 5 (excl. FL, NY), 6 (excl. FL, NY, RI), 8 and 9 for the Canada variants. GEOLOCATION: Use the states parameter for geographic eligibility. NEVER use GeoLocation entry settings for state restrictions — GeoLocation is for GPS/IP boundaries only.

create_rules_wizard

When to use

Generate official sweepstakes rules via the 14-step wizard. BEFORE CALLING: 1) fetch_sweepstakes to get token, dates, name. 2) get_business + get_profile to pre-fill sponsor fields. 3) fetch_rules to check for existing primary rules — if primary exists, warn user new rules will be SECONDARY. Ask wizard questions in order (steps A-N), one at a time or in small groups. Only ask for data you cannot get from API calls. PRIMARY RULES LINK: If result is_primary=true, give user the URL: https://swpp.me/r/[handler] (handler in lowercase from fetch_sweepstakes). RULES LANGUAGE: Always set rules_language="en". The wizard generates ALL legal text server-side — NEVER compose rules language yourself. AMOE URL: The AMOE URL is NOT the entry page URL — the wizard handles AMOE language automatically based on method_of_entry. AGE GATE: Only activate Age Gate when min_age=2 (21+). NEVER for min_age=1 (18+) or min_age=3 (13+). GEOLOCATION: Use the states parameter for geographic eligibility. NEVER use GeoLocation entry settings for state restrictions — GeoLocation is for GPS/IP boundaries only.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

  2. fetch_rules(sweepstakes_token) — if primary rules already exist, WARN that new rules will be SECONDARY (not published)

  3. get_business — auto-populate sponsor info (legal name, address)

  4. get_entry_settings — confirm AMOE state matches the entry method

Parameters to validate before calling

  • sweepstakes_token (string, required) — Sweepstakes token (UUID). Get via fetch_sweepstakes.

  • arv (number, required) — one of: 1, 2 — Approximate Retail Value threshold. 1 = ARV >= $5,000. 2 = ARV < $5,000.

  • alcohol_sweeps (number, required) — one of: 1, 2 — Does the SPONSOR produce or manufacture alcoholic products? 1 = Yes, 2 = No. Only producers/manufacturers count: a retailer, store, supermarket, bar or restaurant that merely sells alcohol is NOT an alcohol sponsor and should be 2. The trigger is who the sponsor is, not what the prize is — a brewery giving away concert tickets is 1. When 1, min_age must be 2 (21+).

  • sweepstakes_name (string, required) — Official promotional name (6-60 characters).

  • start_date (string, required) — Start date (YYYY-MM-DD).

  • start_time (string, required) — Start time (e.g. "09:00 AM" or "14:00").

  • start_timezone (string, required) — Start timezone (e.g. "US/Eastern", "EST", "CST").

  • end_date (string, required) — End date (YYYY-MM-DD).

  • end_time (string, required) — End time (e.g. "11:59 PM" or "23:59").

  • end_timezone (string, required) — End timezone.

  • prize_description (string, required) — Detailed prize description (max 5000 chars).

  • prize_include_travel (boolean, required) — Does the prize include travel?

  • prize_is_vehicle (boolean, required) — Is the prize a vehicle?

  • prize_value (number, required) — Total prize value in USD. Must be > 0.

  • entry_period_selector (number, required) — one of: 1, 2 — 1 = single drawing period, 2 = multiple entry periods.

  • sponsor_name (string, required) — Legal sponsor name. Pre-fill from get_business.

  • sponsor_address (string, required) — Sponsor street address. Pre-fill from get_business.

  • sponsor_city (string, required) — Sponsor city. Pre-fill from get_business.

  • sponsor_state (string, required) — Sponsor state or abbreviation. Pre-fill from get_business.

  • sponsor_zip_code (string, required) — Sponsor zip code (5 digits). Pre-fill from get_business.

  • method_of_entry (number, required) — one of: 1, 2, 3, 4, 5, 6, 7, 8 — Entry 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.

  • min_age (number, required) — one of: 1, 2, 3 — Minimum age: 1=18+, 2=21+, 3=13+ with parental consent.

  • states (number, required) — one of: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 — Geographic eligibility. 1 = 48 contiguous US + DC. 2 = 50 US + DC. 3 = 50 US + DC + US Virgin Islands + Puerto Rico. 4 = specific states (requires list_of_states). 5 = 50 US + DC excluding FL and NY. 6 = 50 US + DC excluding FL, NY and RI. 7 = 50 US + DC + Canada. 8 = 50 US + DC + Canada excluding FL and NY. 9 = 50 US + DC + Canada excluding FL, NY and RI. 10 = Canada only. Values 5, 6, 8 and 9 exist to avoid the registration/bonding requirements of FL, NY and RI. Values 7-10 include Canada: the rules must state that Canadian winners answer a mathematical skill-testing question to receive the prize.

  • privacy_policy_url (string, required) — Privacy policy URL (min 11 chars, must include http/https).

  • sweeppea_entry_page (number, required) — one of: 1, 2, 3 — 1 = Sweeppea hosted page, 2 = custom URL, 3 = none.

  • winners_to_draw (number, optional) — Number of winners to draw (>= 1). Required when entry_period_selector = 1.

  • winner_drawing_date (string, optional) — Drawing date (YYYY-MM-DD). Required when entry_period_selector = 1.

  • winner_drawing_time (string, optional) — Drawing time. Required when entry_period_selector = 1.

  • winner_drawing_timezone (string, optional) — Drawing timezone. Required when entry_period_selector = 1.

  • winner_notification_date (string, optional) — Winner notification date (YYYY-MM-DD). Required when entry_period_selector = 1.

  • winner_notification_time (string, optional) — Winner notification time. Required when entry_period_selector = 1.

  • winner_notification_timezone (string, optional) — Winner notification timezone. Required when entry_period_selector = 1.

  • entry_period_items (array, optional) — Array 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 }.

  • sponsor_telephone (string, optional) — Sponsor phone number (optional). Pre-fill from get_profile.

  • sponsor_email (string, optional) — Sponsor email (optional). Pre-fill from get_profile.

  • social_media_entry_description (string, optional) — Social media entry details. Required when method_of_entry = 3.

  • other_description (string, optional) — Other entry method description. Required when method_of_entry = 4.

  • sponsor_ecommerce_store_url_a (string, optional) — Ecommerce store URL. Required when method_of_entry = 5.

  • sponsor_ecommerce_store_url_b (string, optional) — Ecommerce store URL. Required when method_of_entry = 6.

  • sponsor_donations_acceptance_page_url (string, optional) — Donations acceptance page URL. Required when method_of_entry = 7.

  • sponsor_ecommerce_store_url_c (string, optional) — Ecommerce/subscription store URL. Required when method_of_entry = 8.

  • total_number_of_entries_awarded_amoe (number, optional) — Total entries awarded via AMOE (>= 1). Required when method_of_entry is 5, 6, 7, or 8.

  • limit_or_max_number_of_entries_amoe (number, optional) — Max entries via AMOE (>= 1). Required when method_of_entry is 5, 6, 7, or 8.

  • list_of_states (array, optional) — Array of state names. Required when states = 4.

  • custom_entry_page (string, optional) — Custom entry page URL (min 11 chars). Required when sweeppea_entry_page = 2.

  • sponsor_offering_multiplier (number, optional) — one of: 1, 2 — Is sponsor offering entry multiplier? 1=Yes, 2=No. Default: 2.

  • sponsor_awarding_bonus_email_social (number, optional) — one of: 1, 2 — Awarding bonus for email/social? 1=Yes, 2=No. Default: 2.

  • sponsor_asking_to_submit_video (number, optional) — one of: 1, 2 — Asking for video submission? 1=Yes, 2=No. Default: 2.

  • rules_language (string, optional) — Rules language code. MUST always be "en" (English). The wizard generates all legal text server-side using its own templates — NEVER compose or modify rules language yourself.

Notes

  • Compliance pre-checks: ARV > $5,000 + FL/NY not excluded → WARN about bonding/registration

  • ARV > $500 + sponsor is an RI retailer + entry requires a store visit → WARN about RI registration (all three conditions must be met)

  • Purchase/donation/subscription entry → VERIFY AMOE is configured

  • alcohol_sweeps=1 ONLY when the SPONSOR produces/manufactures alcoholic products — a retailer, store, bar or restaurant that merely sells alcohol is 2; the prize is irrelevant (a brewery giving away concert tickets is 1)

  • Alcohol = yes → VERIFY min_age=21 and Age Gate active; in AL, IN, ME, MD, NC, VT and WV, State Alcohol Board approval is required before launch — warn the user

  • states 5/6/8/9 exist to exclude the FL/NY/RI registration-and-bonding states; 7-10 include Canada (10 is Canada ONLY)

  • Open to Canada (states 7-10) → the rules must state the mathematical skill-testing question for Canadian winners; Quebec-only or Quebec-designated prizes → RACJ registration + French translation of the rules (Canada-wide needs neither)

  • Age < 13 → REFUSE (COPPA violation)

  • After creation: call fetch_rules to verify; use update_rule for corrections

  • at the end of the Official Rules document always include a copyright notice that say "All rights reserved."

Inputs: arv (required), states (required), min_age (required), end_date (required), +48 more.

create_surveyAInspect

Create a survey attached to a sweepstakes, optionally with its full question set. Use fetch_sweepstakes first to get the sweepstakes_token. Requires the Surveys module enabled on the account (disabled by default) — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. STRUCTURAL LIMITS: max 5 questions per page, 50 pages, 250 questions total, 30 options per question. Validation is all-or-nothing: any invalid question rejects the whole request and nothing is written. Pages are renumbered 1..N without gaps; question Order comes from array position. Visual configuration (Visuals, Pages, LogoFile) is managed in the web app and ignored here. To modify questions later use update_survey — only possible while the survey has no responses. DISPLAY RULE: never show SurveyToken/QuestionToken UUIDs; the PublicLink IS meant to be shared with participants.

create_survey

When to use

Create a survey attached to a sweepstakes, optionally with its full question set. Use fetch_sweepstakes first to get the sweepstakes_token. Requires the Surveys module enabled on the account (disabled by default) — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. STRUCTURAL LIMITS: max 5 questions per page, 50 pages, 250 questions total, 30 options per question. Validation is all-or-nothing: any invalid question rejects the whole request and nothing is written. Pages are renumbered 1..N without gaps; question Order comes from array position. Visual configuration (Visuals, Pages, LogoFile) is managed in the web app and ignored here. To modify questions later use update_survey — only possible while the survey has no responses. DISPLAY RULE: never show SurveyToken/QuestionToken UUIDs; the PublicLink IS meant to be shared with participants.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID v4) the survey belongs to

  • survey_name (string, required) — Survey name (max 200 characters)

  • status (boolean, optional) — Initial enabled state (optional, default true)

  • settings (object, optional) — Optional settings object with PascalCase keys: Description, QuestionsPerPage (1-5), CollectContactInfo, ShowProgressBar, ShuffleQuestions, AllowMultipleResponses, ThankYouMessage, RedirectUrl, StartDate, EndDate, MaxResponses, ShowCountdown, EnableSharing, Language ("en"|"es")

  • questions (array, optional) — Optional questions array with PascalCase keys per item: {"QuestionText" (required), "FieldType" (required: text|textarea|radio|checkbox|select|slider|rating|nps|yesno|date), "Page", "QuestionDescription", "Layout", "Required", "Options": [...max 30, each option is an object {"Label": "..."}], "Settings": {e.g. RatingMax, RatingIcon}}

Notes

  • Requires the Surveys module enabled on the account — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support

  • Structural limits: 5 questions/page, 50 pages, 250 questions total, 30 options/question

  • Each Option is an object with a Label key, e.g. "Options": [{"Label": "Friend"}, {"Label": "Social media"}] — never plain strings

  • Validation is all-or-nothing: any invalid question rejects the whole request and nothing is written

  • Questions can only be replaced later (update_survey) while the survey has no responses

Inputs: survey_name (required), sweepstakes_token (required), status, settings, +1 more.

create_sweepstakesAInspect

Create a new sweepstakes programmatically. Requires name, handler (unique identifier), dates, and times. Type defaults to 2 (Email) — SMS and Social are rarely used and require explicit user request. 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: Each account has a per-plan cap on total sweepstakes (no separate active/total distinction). Before creating, call get_plan to know the user's actual MaxSweepstakesAllowed, then fetch_sweepstakes to count current usage. If the user is at or near the cap, warn them before proceeding (e.g., "you have 9 of 10 sweepstakes allowed by your plan"). AUDIENCE: Sweeppea entry pages collect personal data from whoever enters, so the entrants must be adults. If the user describes a promotion aimed at children or teenagers, ask who actually submits the entry BEFORE creating: a parent or guardian entering on the child's behalf is the compliant setup. The server blocks names that refer to a minor audience until you pass entrants_are_18_or_older: true. Never resolve this by silently publishing 18+ rules for a promotion the user described as being for kids. Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. Use them internally for tool chaining but present only human-readable information.

create_sweepstakes

When to use

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: Each account has a per-plan cap on total sweepstakes (no separate active/total distinction). Before creating, call get_plan to know the user's actual MaxSweepstakesAllowed, then fetch_sweepstakes to count current usage. If the user is at or near the cap, warn them before proceeding (e.g., "you have 9 of 10 sweepstakes allowed by your plan"). Ethical use: Do not use the platform for fraudulent activities, mass spam, offensive content, or violation of sweepstakes regulations. Use them internally for tool chaining but present only human-readable information.

Pre-calls required

  1. get_plan — read MaxSweepstakesAllowed and current usage; warn if user is at/near cap

  2. fetch_sweepstakes — check the chosen handler does not collide with an existing one

  3. fetch_timezones — pick the right timezone for the sponsor

Parameters to validate before calling

  • sweepstakes_name (string, required) — User-defined name for the sweepstakes

  • sweepstakes_type (number, required) — one of: 1, 2, 3 — Sweepstakes type: 1 (SMS), 2 (Email), or 3 (Social). Default: 2 (Email)

  • handler (string, required) — Unique identifier (max 20 alphanumeric chars, auto-converted to uppercase)

  • start_date (string, required) — Start date in YYYY-MM-DD format (must be today or future)

  • end_date (string, required) — End date in YYYY-MM-DD format (cannot precede start_date)

  • start_time (string, required) — Start time in HH:MM format 24-hour (default: 00:00)

  • end_time (string, required) — End time in HH:MM format 24-hour (default: 23:59)

  • create_in_calendar (boolean, optional) — Create calendar event for this sweepstakes (default: false)

  • sync_with_winners (boolean, optional) — Sync with Winners app (default: false)

  • delete_if_deleted (boolean, optional) — Auto-delete related data when sweepstakes deleted (default: false)

  • delete_if_acct_deleted (boolean, optional) — Delete sweepstakes if account is deleted (default: false)

Eligibility — establish BEFORE calling

Sweepstakes are entered by adults. Before creating, establish who will ENTER, which is not the same as who the prize is for:

  • Prize aimed at children (toys, games) with adult entrants: fine, proceed.

  • Entrants under 18: the entrants must be the parents or legal guardians.

  • Entrants under 13, or collecting name/email/age from children under 13: STOP. Do not call this tool. Promotions that collect personal data from children under 13 are prohibited on the platform (COPPA). Explain why and offer the compliant alternative: adults enter on behalf of their children.

NEVER resolve an under-13 audience by promising "parental consent". The platform does not implement verifiable parental consent, and the promotion is prohibited regardless. Offering it as a solution misleads the user.

Notes

  • Always set create_in_calendar: true and sync_with_winners: true

  • Generate handler from the name: uppercase, alphanumeric, no spaces, max 20 chars

  • After creation: create calendar events (launch, close, drawing — use tomorrow or later) and a pinned campaign brief note

Inputs: handler (required), end_date (required), end_time (required), start_date (required), +8 more.

create_ticketAInspect

Create a new support ticket with title, description, priority level and platform. PLATFORM: Whenever the user names the product the ticket is about (e.g. "a change in a Renaissance feature", "the Shopify app", "Winners"), set platform to its id. If omitted, the ticket is filed under "general". ASSIGNMENT: Whenever the user says who the ticket is for ("for Martin", "assign it to martin@..."), pass that name or email in assign_to — a first name is enough. If omitted, the ticket is assigned to all admins. Only admin-level users can be assigned. If the API answers that the name matches more than one admin, ask the user which of the returned candidates they mean and retry with the full name. NEVER invent a name or email the user did not mention. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

create_ticket

When to use

Create a new support ticket with title, description, and priority level. ASSIGNMENT: Optionally assign to a specific admin by name or email via assign_to. If omitted, the ticket is assigned to all admins. Only admin-level users can be assigned. NEVER guess or fabricate admin names or emails — only use assign_to if the user explicitly provides a name or email. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

Parameters to validate before calling

  • title (string, required) — Ticket subject/title (max 200 characters)

  • description (string, required) — Detailed description of the issue (max 20,000 characters). Allowed HTML: , , , , . No scripts, iframes, or executable code.

  • priority (number, required) — one of: 1, 2, 3 — Priority level: 1 (Low), 2 (Medium), 3 (High)

  • assign_to (string, optional) — Name or email of an admin user to assign the ticket to exclusively. If omitted, the ticket is assigned to all admins. Matching is case-insensitive for names and exact for emails. Only admin-level users can be assigned.

Notes

  • Allowed HTML tags: b, strong, i, hr, br

  • Do NOT use &nbsp; — only for line breaks within text

  • Search fetch_documentation first; only open a ticket if docs do not solve the question

Inputs: title (required), priority (required), description (required), platform, +1 more.

create_todoAInspect

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. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

create_todo

When to use

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. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

Parameters to validate before calling

  • title (string, required) — To-Do title (max 200 characters).

  • priority (number, required) — one of: 1, 2, 3 — Priority level: 1 = Low, 2 = Medium, 3 = High.

  • description (string, optional) — Detailed description (max 20,000 characters). Allowed HTML: , , , , . No scripts, iframes, or executable code.

  • resource_affected (string, optional) — Resource affected (e.g. "renaissance", "api", "aws", "general"). Default: "general".

  • pin (boolean, optional) — Pin this To-Do to the top. Default: false.

  • deadline (string, optional) — Deadline date in ISO 8601 format (e.g. "2026-03-01").

Notes

  • Admin-only tool

  • Allowed HTML tags: b, strong, i, hr, br

Inputs: title (required), priority (required), pin, deadline, +2 more.

delete_calendar_eventA
DestructiveIdempotent
Inspect

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

delete_calendar_event

When to use

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

Parameters to validate before calling

  • event_token (string, required) — The event token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), event_token (required).

delete_codesA
DestructiveIdempotent
Inspect

Permanently delete 1 to 1,000 codes. IRREVERSIBLE. Only codes nobody holds are deleted — assigned, redeemed and voided codes are never removed and come back in Skipped, so always report Deleted and SkippedCount to the user rather than assuming the whole batch went. confirm=true is REQUIRED on every call; set it only after the user confirmed THIS deletion. To take a code back from a participant instead, use unassign_code. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: confirm (required), coupon_tokens (required).

delete_fileA
DestructiveIdempotent
Inspect

DESTRUCTIVE — IRREVERSIBLE. Permanently delete a file from the user's Drive. Removes the file from S3 storage and the database. Storage quota is freed immediately. ALWAYS ask for explicit user confirmation before calling this tool.

delete_file

When to use

DESTRUCTIVE — IRREVERSIBLE. Permanently delete a file from the user's Drive. Removes the file from S3 storage and the database. Storage quota is freed immediately. ALWAYS ask for explicit user confirmation before calling this tool.

Parameters to validate before calling

  • file_token (string, required) — The file token (UUID) of the file to delete. Get via fetch_files.

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), file_token (required).

delete_groupA
DestructiveIdempotent
Inspect

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.

delete_group

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • group_token (string, required) — The group token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), group_token (required), sweepstakes_token (required).

delete_invoiceA
DestructiveIdempotent
Inspect

Permanently delete an invoice. IRREVERSIBLE — NEVER call without explicit user confirmation for this specific invoice. Deleting is NOT the same as cancelling: to keep the invoice as history, use update_invoice with status "cancelled" instead, and offer that alternative to the user first. Money survives: wallet transactions and Sweeppea commissions from a paid invoice are NEVER deleted. Requires the Invoices module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.

delete_invoice

When to use

Permanently delete an invoice. IRREVERSIBLE — NEVER call without explicit user confirmation for this specific invoice. Deleting is NOT the same as cancelling: to keep the invoice as history, use update_invoice with status "cancelled" instead, and offer that alternative to the user first. Money survives: wallet transactions and Sweeppea commissions from a paid invoice are NEVER deleted. Requires the Invoices module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.

Pre-calls required

  1. get_invoice — confirm which invoice is being deleted and show the user its InvoiceNumber and status

Parameters to validate before calling

  • invoice_token (string, required) — The invoice token (UUID v4) of the invoice to delete

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

  • NOT the same as cancelling — offer update_invoice with status "cancelled" first (keeps the invoice as history)

  • Wallet transactions and Sweeppea commissions from a paid invoice are NEVER deleted

Inputs: confirm (required), invoice_token (required).

delete_noteA
DestructiveIdempotent
Inspect

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

delete_note

When to use

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

Parameters to validate before calling

  • note_token (string, required) — The note token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), note_token (required).

delete_participantA
DestructiveIdempotent
Inspect

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

delete_participant

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • participant_token (string, required) — The participant token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), participant_token (required), sweepstakes_token (required).

delete_ruleA
DestructiveIdempotent
Inspect

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

delete_rule

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • rules_token (string, required) — The rules token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), rules_token (required), sweepstakes_token (required).

delete_scheduled_drawingA
DestructiveIdempotent
Inspect

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. Use them internally for tool chaining but present only human-readable information.

delete_scheduled_drawing

When to use

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. Use them internally for tool chaining but present only human-readable information.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • schedule_token (string, required) — The scheduled drawing token to delete (UUID format)

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), schedule_token (required), sweepstakes_token (required).

delete_surveyA
DestructiveIdempotent
Inspect

Permanently delete a survey. IRREVERSIBLE — deletes the survey, its questions, ALL collected responses, stats and uploaded files. NEVER call without explicit user confirmation for this specific survey, spelling out what will be lost. confirm=true is REQUIRED for every call and is also what the API demands when the survey already has responses — set it only after the user explicitly accepted losing them. Participants created from the survey and the sweepstakes itself are preserved. To disable a survey WITHOUT losing data, use update_survey with status false instead — always offer that alternative first. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.

delete_survey

When to use

Permanently delete a survey. IRREVERSIBLE — deletes the survey, its questions, ALL collected responses, stats and uploaded files. NEVER call without explicit user confirmation for this specific survey, spelling out what will be lost. If the survey has responses the API additionally requires confirm=true (409 otherwise) — only pass confirm=true after the user explicitly accepted losing the responses. Participants created from the survey and the sweepstakes itself are preserved. To disable a survey WITHOUT losing data, use update_survey with status false instead — always offer that alternative first. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support.

Pre-calls required

  1. get_survey — check ResponsesCount and tell the user exactly what will be lost

Parameters to validate before calling

  • survey_token (string, required) — The survey token (UUID v4) of the survey to delete

  • confirm (boolean, optional) — Required true ONLY when the survey already has responses. Pass it ONLY after the user explicitly confirmed losing all responses

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

  • Deletes questions, ALL responses, stats and uploaded files. Participants created from the survey are preserved

  • confirm: true is required when responses exist — pass it ONLY after the user explicitly accepted losing them

  • Offer update_survey with status false first (disable without data loss)

Inputs: confirm (required), survey_token (required).

delete_sweepstakesA
DestructiveIdempotent
Inspect

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.

delete_sweepstakes

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The unique identifier (token) of the sweepstakes to delete

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

  • IRREVERSIBLE — destroys ALL associated data (participants, rules, winners, statistics)

  • ALWAYS require explicit user confirmation. Explain exactly what will be lost.

Inputs: confirm (required), sweepstakes_token (required).

delete_ticketA
DestructiveIdempotent
Inspect

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.

delete_ticket

When to use

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.

Parameters to validate before calling

  • case_id (string, required) — The case number of the ticket to delete

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: case_id (required), confirm (required).

delete_todoA
DestructiveIdempotent
Inspect

Permanently delete a To-Do item. WARNING: This action cannot be undone. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API.

delete_todo

When to use

Permanently delete a To-Do item. WARNING: This action cannot be undone. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API.

Parameters to validate before calling

  • todo_token (string, required) — The To-Do token to delete (UUID format).

Notes

  • DESTRUCTIVE — IRREVERSIBLE. Always confirm with the user before calling. Explain what will be lost.

Inputs: confirm (required), todo_token (required).

draw_winnersAInspect

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. Use them internally for tool chaining but present only human-readable information (names, emails).

draw_winners

When to use

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. Use them internally for tool chaining but present only human-readable information (names, emails).

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

  2. fetch_rules(sweepstakes_token) — confirm Official Rules exist (drawing is illegal without them)

  3. count_participants — verify there are enough entries for the requested winners count

  4. Confirm the entry period has ended for the relevant drawing window

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • how_many_winners (number, required) — Number of winners to pick (must be >= 1)

  • group (string, required) — Group token to draw from, or "allgroups" for all participants

  • completed_entries (boolean, optional) — Only include participants with completed entries (default: true)

  • include_opted_out (boolean, optional) — Include participants who opted out (default: false)

  • exclude_spam (boolean, optional) — Exclude flagged spam participants (default: true)

Notes

  • After drawing: fetch_winners to confirm, update the campaign brief note, create a calendar event for winner notification deadline

  • Remind the user about web-interface steps: classify winners, send notifications, publish Winners List

Inputs: group (required), how_many_winners (required), sweepstakes_token (required), exclude_spam, +2 more.

fetch_areacodesA
Read-onlyIdempotent
Inspect

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

fetch_areacodes

When to use

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

Parameters to validate before calling

  • search (string, optional) — Search term: area code number or state name (optional, omit to get all)

Inputs: search.

fetch_billing_consumptionsA
Read-onlyIdempotent
Inspect

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

fetch_billing_consumptions

When to use

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

Inputs: no named parameters.

fetch_billing_transactionsB
Read-onlyIdempotent
Inspect

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

fetch_billing_transactions

When to use

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

Inputs: no named parameters.

fetch_calendar_eventsA
Read-onlyIdempotent
Inspect

Get all calendar events for your account. Returns events with their details including dates, times, location, and status. Use them internally for tool chaining but present only human-readable information (titles, dates, times, locations).

fetch_calendar_events

When to use

Get all calendar events for your account. Returns events with their details including dates, times, location, and status. Use them internally for tool chaining but present only human-readable information (titles, dates, times, locations).

Inputs: no named parameters.

fetch_campaign_recipientsA
Read-onlyIdempotent
Inspect

List who a campaign went to and what happened to each message, paginated. Defaults to 25 per page, maximum 100. search takes ONE EXACT email address or phone number, not a fragment — use the status filter to narrow, not search. Recipient addresses are personal data: report them to the user who owns the account, never carry them into another context. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: campaign_token (required), page, search, status, +1 more.

fetch_campaign_reportA
Read-onlyIdempotent
Inspect

Delivery report of one campaign: counters, rates over sent, messages by status, top error codes, sends per hour and most-clicked links. Rates are computed over messages SENT, not over the audience — say which denominator you are quoting when you report a percentage to the user. rows_expired true means the per-recipient rows aged out, so the detail behind the counters is gone. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: campaign_token (required).

fetch_campaignsA
Read-onlyIdempotent
Inspect

List the account email and SMS campaigns, newest first, with filters and pagination. Defaults to 25 per page, maximum 100. Campaigns CANNOT be created through this API — this MCP can only read them, pause, resume and cancel. The API leaves campaign creation out on purpose (confirmed by the API maintainer, October 2026), so it is a deliberate boundary rather than a gap waiting to be filled. Email templates and sender profiles have no endpoints at all, for the same reason. If the user wants a new campaign, say so plainly and point them at the Sweeppea app; do not pretend a tool exists and do not propose one. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: page, search, status, channel, +4 more.

fetch_closed_ticketsA
Read-onlyIdempotent
Inspect

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).

fetch_closed_tickets

When to use

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).

Parameters to validate before calling

  • search (string, optional) — Search by subject or description (case-insensitive)

  • platform (string, optional) — Filter by platform: renaissance, api, general, overture, winners

  • priority (number, optional) — one of: 1, 2, 3 — Filter by priority: 1 (Low), 2 (Medium), 3 (High)

  • page (number, optional) — Page number for pagination (default: 1, 20 tickets per page)

Inputs: page, search, platform, priority.

fetch_codesA
Read-onlyIdempotent
Inspect

One page of a sweepstakes codes, with the participant each code is assigned to. Filtering, search and sorting all happen server-side — use filter and search rather than pulling every page and filtering yourself. Defaults to 25 per page, maximum 500. available means not redeemed AND not assigned. For a plain count use fetch_code_stats instead, it is far cheaper. Read-only and NOT gated by the Codes & Coupons module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: sweepstakes_token (required), page, filter, search, +3 more.

fetch_code_statsA
Read-onlyIdempotent
Inspect

Count the codes of a sweepstakes: total, assigned, unassigned, redeemed, voided and available. Read-only and cheap — call this before fetch_codes when the user asks "how many codes do I have left", instead of paging through the list. Read-only and NOT gated by the Codes & Coupons module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: sweepstakes_token (required).

fetch_countriesA
Read-onlyIdempotent
Inspect

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.

fetch_countries

When to use

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.

Parameters to validate before calling

  • search (string, optional) — Search term: country name, dial code (e.g. "+34"), or ISO code (e.g. "US") (optional, omit to get all)

Inputs: search.

fetch_data_transferA
Read-onlyIdempotent
Inspect

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

fetch_data_transfer

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token to fetch data transfer records from (UUID format)

Inputs: sweepstakes_token (required).

fetch_documentationA
Read-onlyIdempotent
Inspect

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

fetch_documentation

When to use

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

Parameters to validate before calling

  • page (number, optional) — Page number to retrieve (default: 1)

  • limit (number, optional) — Number of documents per page, max 10 (default: 5)

  • search (string, optional) — Search term to filter documents by title or content

Inputs: page, limit, search.

fetch_drip_enrollmentsA
Read-onlyIdempotent
Inspect

List the contacts enrolled in a drip campaign: where each one is in the sequence, what is scheduled next, and why anyone left. Defaults to 25 per page, maximum 100. Rows are passed through exactly as the API sends them, in PascalCase. Each row carries SourceType — participant, amoe, lead or subscriber — so read it before treating the id as a participant. This endpoint NEVER returns email addresses or phone numbers: you cannot look a contact up by address here, and source_token is the only handle you get. ExitReason is a closed vocabulary — unsubscribed, suppressed, no_consent, removed, clicked, won, invalid, undeliverable or over_quota: quote the value, do not paraphrase it into a cause you were not given. NextStep is 1-BASED — verified against a live enrolment whose step at Index 0 had been sent and whose NextStep read 2 — while Steps[].Index in get_drip and in fetch_drip_report is 0-based, so NextStep N is the step at Index N-1. A row also carries EnrollmentToken, Status, EnrolledAt, LastSentAt, NextStepAt and EndedAt; ExitReason is null while the contact is still in the sequence, not absent, so treat null as "has not left" rather than as missing data. Ended enrolments are kept 180 days and then disappear: an absent row means "not in the last 180 days", NEVER "this contact was never enrolled". Enrollment rows identify people; report them to the account owner and do not copy them elsewhere. Account-gated, and the two sides of this category are gated differently: the reads need only the Drip Marketing module, while pause_drip, resume_drip and remove_drip_contact need Drip Marketing plus Send Message. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: drip_token (required), page, status, source_token, +1 more.

fetch_drip_reportA
Read-onlyIdempotent
Inspect

Message statistics of a drip campaign: per step, in total, day by day, and the links people clicked. The activity window is 7, 30, 90 or 180 days and defaults to 30 — a number outside that set is rejected. Rates are percentages already computed by the server; quote them as given rather than recalculating, and say which window you are reporting. The window stops at 180 days because message rows are only kept that long — a longer window does not exist, so do not offer one. Test sends are EXCLUDED from every counter, so a user who only tested the drip sees zeros and that is correct, not a failure. Daily rows are UTC days, which can shift a figure by one day against the user local calendar — say which day you mean. top_links holds up to 10 most-clicked links and excludes the unsubscribe link. An empty array means nobody clicked; null means the links could not be read, which is unknown, NOT zero — report those two differently. This one response carries TWO different step numbering schemes at once: steps[].Index is 0-BASED (verified against a live report on 2026-10-12), while the Step on each top_links entry is 1-BASED (documented only — no drip with clicks has existed to check it). Within the same payload, steps[].Index N and a top_links Step of N+1 are the same step. Steps and links arrive in PascalCase, exactly as the API sends them. Account-gated, and the two sides of this category are gated differently: the reads need only the Drip Marketing module, while pause_drip, resume_drip and remove_drip_contact need Drip Marketing plus Send Message. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: drip_token (required), days.

fetch_dripsA
Read-onlyIdempotent
Inspect

List the account drip campaigns — automated email or SMS sequences — with their status, people counters and the plan allowance. Defaults to 25 per page, maximum 100. The counters here count PEOPLE in the sequence (enrolled, active, completed, exited), NOT messages: never report "1,240 sent" from an Enrolled of 1,240. Counters is NOT four numbers: Enrolled, Active and Completed are counts, but Exited is an OBJECT keyed by the same nine reasons as ExitReason in fetch_drip_enrollments (Unsubscribed, Suppressed, NoConsent, Removed, Clicked, Won, Invalid, Undeliverable, OverQuota), and Deferred is an object with Capped and OverQuota. The documented field table calls Exited "by reason" without naming the keys; the nine above are the ones ExitReason enumerates and the shape was confirmed on a live drip 2026-10-13. Add the object up if the user wants one number, and never print it as though it already were one. Message statistics live in fetch_drip_report only. Contact addresses never appear in any drip response. The response carries can_run, which the API documents as whether the PLAN lets drips be activated or resumed — a false there does NOT mean the module is disabled, so never report it as one. Alongside it, plan_limit is passed through in PascalCase and gives MaxAllowed (0 means unlimited), CurrentCount, LimitReached and Unlimited (true when the plan sets no drip limit, that is MaxAllowed 0); LimitReached true means no further drip can be created, which is an app action anyway. can_run is INDEPENDENT of those counters — it was observed false on a live account while CurrentCount was 0 and LimitReached was false, so never explain a false can_run by the allowance. It tells you THAT the plan does not allow it, never WHY: the cause only surfaces when a write is refused, and what a refusal actually carries has now been measured — a pause refused on a draft answered 409 with api_data.Status naming the status, NOT a Reason (verified live 2026-10-13). The documented Reason vocabulary (PlanDoesNotAllowSharing, ChannelNotInPlan, NoRegisteredSmsSender, StaffHold) has still never been seen on a real response, so read the message and never claim a Reason the response did not include. Do not guess between them from can_run alone. Account-gated, and the two sides of this category are gated differently: the reads need only the Drip Marketing module, while pause_drip, resume_drip and remove_drip_contact need Drip Marketing plus Send Message. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: page, search, status, channel, +3 more.

fetch_filesA
Read-onlyIdempotent
Inspect

List all files in the user's Drive with storage usage, categories, and pagination. Files are sorted by creation date (newest first).

fetch_files

When to use

List all files in the user's Drive with storage usage, categories, and pagination. Files are sorted by creation date (newest first).

Parameters to validate before calling

  • page (number, optional) — Page number (default: 1)

  • limit (number, optional) — Files per page (default: 50, max: 200)

Inputs: page, limit.

fetch_groupsA
Read-onlyIdempotent
Inspect

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

fetch_groups

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

Inputs: sweepstakes_token (required).

fetch_invoicesA
Read-onlyIdempotent
Inspect

Fetch a paginated list of invoices for the account, with optional filters by status and date range. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. The Summary block (totals and counts) covers the ENTIRE filtered set, not just the current page. IsOverdue is derived at read time (stored status stays "pending"). Archived invoices are included with Archived: true. For full details of one invoice (line items, notes, QR) use get_invoice. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs — present InvoiceNumber, recipient, dates, totals and status instead.

fetch_invoices

When to use

Fetch a paginated list of invoices for the account, with optional filters by status and date range. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. The Summary block (totals and counts) covers the ENTIRE filtered set, not just the current page. IsOverdue is derived at read time (stored status stays "pending"). Archived invoices are included with Archived: true. For full details of one invoice (line items, notes, QR) use get_invoice. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs — present InvoiceNumber, recipient, dates, totals and status instead.

Parameters to validate before calling

  • status (string, optional) — one of: draft, pending, paid, cancelled — Filter by invoice status (optional)

  • from_date (string, optional) — Inclusive start date in ISO format YYYY-MM-DD (optional)

  • to_date (string, optional) — Inclusive end date in ISO format YYYY-MM-DD (optional)

  • page (number, optional) — range: 1–+∞ — Page number (optional, default 1)

  • limit (number, optional) — range: 1–200 — Results per page (optional, default 50, max 200)

Inputs: page, limit, status, to_date, +1 more.

fetch_messaging_usageA
Read-onlyIdempotent
Inspect

Read the account messaging state: module access, which channels the plan allows, this month email and SMS allowance, SMS sender readiness (10DLC) and any active sending pause. Takes no parameters. CALL THIS FIRST whenever a send is refused or before promising the user that a send will work — it is the only tool that tells you WHICH of those causes produced a 403, instead of guessing. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: no named parameters.

fetch_notesA
Read-onlyIdempotent
Inspect

Get all notes for your account. Notes are automatically decrypted and returned in reverse chronological order. Use them internally for tool chaining but present only human-readable information (titles, content, dates).

fetch_notes

When to use

Get all notes for your account. Notes are automatically decrypted and returned in reverse chronological order. Use them internally for tool chaining but present only human-readable information (titles, content, dates).

Inputs: no named parameters.

fetch_open_ticketsA
Read-onlyIdempotent
Inspect

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).

fetch_open_tickets

When to use

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).

Parameters to validate before calling

  • search (string, optional) — Search by subject or description (case-insensitive)

  • platform (string, optional) — Filter by platform: renaissance, api, general, overture, winners

  • priority (number, optional) — one of: 1, 2, 3 — Filter by priority: 1 (Low), 2 (Medium), 3 (High)

  • page (number, optional) — Page number for pagination (default: 1, 20 tickets per page)

Inputs: page, search, platform, priority.

fetch_participantsA
Read-onlyIdempotent
Inspect

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. Use them internally for tool chaining but present only human-readable information (names, emails, phones, dates).

fetch_participants

When to use

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. Use them internally for tool chaining but present only human-readable information (names, emails, phones, dates).

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • page (number, optional) — Page number for pagination (default: 1, 20 results per page)

  • search (string, optional) — Search by first name, last name, email, or phone number (case-insensitive)

  • opt_in_date (string, optional) — Filter by specific opt-in date (YYYY-MM-DD)

  • start_date (string, optional) — Start of date range filter (YYYY-MM-DD, requires end_date)

  • end_date (string, optional) — End of date range filter (YYYY-MM-DD, requires start_date)

Inputs: sweepstakes_token (required), page, search, end_date, +2 more.

fetch_rulesA
Read-onlyIdempotent
Inspect

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

fetch_rules

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token to fetch rules from (UUID format)

Inputs: sweepstakes_token (required).

fetch_scheduled_drawingsA
Read-onlyIdempotent
Inspect

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). Use them internally for tool chaining but present only human-readable information (dates, times, status, winner counts).

fetch_scheduled_drawings

When to use

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). Use them internally for tool chaining but present only human-readable information (dates, times, status, winner counts).

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

Inputs: sweepstakes_token (required).

fetch_statesA
Read-onlyIdempotent
Inspect

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

fetch_states

When to use

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

Inputs: no named parameters.

fetch_suppressionsA
Read-onlyIdempotent
Inspect

List the account do-not-contact list: every address that unsubscribed, replied STOP, complained, bounced or was added by hand. Defaults to 25 per page, maximum 100. search takes ONE EXACT address; without a channel, a value containing @ is searched as email and anything else as SMS. Each row carries a reason — only reason manual can ever be removed, so check it before promising the user you can undo a suppression. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: page, search, channel, items_per_page.

fetch_survey_reportA
Read-onlyIdempotent
Inspect

Fetch the aggregated report of a survey: visit/start/complete totals, completion rate and times, device and browser breakdown, daily timeline, and per-question answer distributions. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. Distributions are capped at 25 buckets — the long tail counts toward TotalAnswers but does not travel (Truncated flag). A survey with no traffic returns the full structure with zeros — report that honestly, never invent activity. CompletionRate = Completes/Visits as an integer percentage; CompletionTimes are in seconds. For raw individual responses use fetch_survey_responses.

fetch_survey_report

When to use

Fetch the aggregated report of a survey: visit/start/complete totals, completion rate and times, device and browser breakdown, daily timeline, and per-question answer distributions. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. Distributions are capped at 25 buckets — the long tail counts toward TotalAnswers but does not travel (Truncated flag). A survey with no traffic returns the full structure with zeros — report that honestly, never invent activity. CompletionRate = Completes/Visits as an integer percentage; CompletionTimes are in seconds. For raw individual responses use fetch_survey_responses.

Parameters to validate before calling

  • survey_token (string, required) — The survey token (UUID v4). Get it via fetch_surveys

  • timeline_days (number, optional) — range: 1–365 — Days back for the daily timeline (optional, default 30, max 365)

Inputs: survey_token (required), timeline_days.

fetch_survey_responsesA
Read-onlyIdempotent
Inspect

Fetch individual survey responses (paginated, newest first) with each answer. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. PRIVACY: include_metadata adds PII (IP address, user agent, device) — keep it false unless the user explicitly needs it, and NEVER copy that metadata into notes, tickets or any other field. ParticipantToken is null when no contact info was collected. For aggregated results use fetch_survey_report; for unlimited export point the user to the Export CSV button in the app. DISPLAY RULE: never show ResponseToken/ParticipantToken UUIDs.

fetch_survey_responses

When to use

Fetch individual survey responses (paginated, newest first) with each answer. Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. PRIVACY: include_metadata adds PII (IP address, user agent, device) — keep it false unless the user explicitly needs it, and NEVER copy that metadata into notes, tickets or any other field. ParticipantToken is null when no contact info was collected. For aggregated results use fetch_survey_report; for unlimited export point the user to the Export CSV button in the app. DISPLAY RULE: never show ResponseToken/ParticipantToken UUIDs.

Parameters to validate before calling

  • survey_token (string, required) — The survey token (UUID v4). Get it via fetch_surveys

  • completed (boolean, optional) — true = completed only, false = abandoned only, omit = both (optional)

  • from_date (string, optional) — Inclusive start date YYYY-MM-DD (optional)

  • to_date (string, optional) — Inclusive end date YYYY-MM-DD, covers the whole day (optional)

  • include_metadata (boolean, optional) — Include device/browser/IP metadata — PII, default false. Only set true if the user explicitly needs it

  • page (number, optional) — range: 1–+∞ — Page number (optional, default 1)

  • limit (number, optional) — range: 1–100 — Results per page (optional, default 25, max 100)

Notes

  • include_metadata adds PII (IP address, user agent, device) — keep it false unless the user explicitly needs it

  • NEVER copy response metadata into notes, tickets or any other field

  • For unlimited export point the user to the Export CSV button in the app

Inputs: survey_token (required), page, limit, to_date, +3 more.

fetch_surveysA
Read-onlyIdempotent
Inspect

Fetch a paginated list of surveys, optionally filtered by sweepstakes, enabled state or archived state. An empty filter returns all surveys in the account. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. IsLocked is derived at read time: true when the survey already has responses (its question structure can no longer be replaced). Questions are NOT included here — use get_survey for the full question set. DISPLAY RULE: never show SurveyToken UUIDs; present survey names, counts and the shareable PublicLink instead.

fetch_surveys

When to use

Fetch a paginated list of surveys, optionally filtered by sweepstakes, enabled state or archived state. An empty filter returns all surveys in the account. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. IsLocked is derived at read time: true when the survey already has responses (its question structure can no longer be replaced). Questions are NOT included here — use get_survey for the full question set. DISPLAY RULE: never show SurveyToken UUIDs; present survey names, counts and the shareable PublicLink instead.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, optional) — Filter by a specific sweepstakes (UUID v4, optional)

  • status (boolean, optional) — true = enabled only, false = disabled only, omit = both (optional)

  • archived (boolean, optional) — Filter by archived state; omit for both (optional)

  • page (number, optional) — range: 1–+∞ — Page number (optional, default 1)

  • limit (number, optional) — range: 1–200 — Results per page (optional, default 50, max 200)

Inputs: page, limit, status, archived, +1 more.

fetch_sweepstakesA
Read-onlyIdempotent
Inspect

Get the sweepstakes associated with your account. Returns a paginated SUMMARY by default (token, name, handler, type, dates, timezone, status, archived, and a computed state). STATE: each item carries state — "scheduled" (not started), "running" (open now), or "ended" (end date already passed) — plus has_ended and days_until_end. ALWAYS read state before giving operational advice: never tell the user to share the entry link or wait for participants on a sweepstakes whose state is "ended". PAGINATION: use page and page_size (default 25, max 100). The response carries pagination.total, total_pages and has_more — if has_more is true, either request the next page or tell the user how many were not shown. NEVER invent sweepstakes that are not in the response. HEAVY PAYLOAD: include_settings: true adds the full Settings object (SMS/email templates, ~1.5 KB each) — only request it when the user asks about entry page settings or message templates, and prefer get_entry_settings for a single sweepstakes. Use tokens internally for tool chaining but present only human-readable information (names, dates, statuses) to the user.

fetch_sweepstakes

When to use

Get the sweepstakes associated with your account. Returns a paginated SUMMARY by default (token, name, handler, type, dates, timezone, status, archived, and a computed state). STATE: each item carries state — "scheduled" (not started), "running" (open now), or "ended" (end date already passed) — plus has_ended and days_until_end. ALWAYS read state before giving operational advice: never tell the user to share the entry link or wait for participants on a sweepstakes whose state is "ended". PAGINATION: use page and page_size (default 25, max 100). The response carries pagination.total, total_pages and has_more — if has_more is true, either request the next page or tell the user how many were not shown. NEVER invent sweepstakes that are not in the response. HEAVY PAYLOAD: include_settings: true adds the full Settings object (SMS/email templates, ~1.5 KB each) — only request it when the user asks about entry page settings or message templates, and prefer get_entry_settings for a single sweepstakes. Use tokens internally for tool chaining but present only human-readable information (names, dates, statuses) to the user.

Parameters to validate before calling

  • page (number, optional) — range: 1–+∞ — Page number, 1-based. Default: 1.

  • page_size (number, optional) — range: 1–100 — Sweepstakes per page. Default: 25, maximum: 100.

  • include_settings (boolean, optional) — Include the full Settings object of each sweepstakes (heavy: ~1.5 KB each, mostly SMS/email templates). Default: false.

  • include_archived (boolean, optional) — Include archived sweepstakes. Default: true.

Inputs: page, page_size, include_archived, include_settings.

fetch_timezonesA
Read-onlyIdempotent
Inspect

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).

fetch_timezones

When to use

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).

Inputs: no named parameters.

fetch_todosA
Read-onlyIdempotent
Inspect

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.

fetch_todos

When to use

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.

Parameters to validate before calling

  • page (number, optional) — Page number (default: 1, 20 items per page).

  • search (string, optional) — Search by title or description (case-insensitive).

  • status (string, optional) — one of: pending, completed — Filter by status: "pending" or "completed".

  • priority (number, optional) — one of: 1, 2, 3 — Filter by priority: 1 = Low, 2 = Medium, 3 = High.

  • resource (string, optional) — Filter by resource affected (e.g. "renaissance", "api", "aws", "general").

  • pinned (boolean, optional) — Filter pinned items only when true.

  • date_from (string, optional) — Start date filter in ISO 8601 format (e.g. "2026-01-01").

  • date_to (string, optional) — End date filter in ISO 8601 format (e.g. "2026-12-31").

  • year (number, optional) — Filter by creation year (ignored if date_from/date_to provided).

  • month (number, optional) — Filter by creation month 1-12 (requires year parameter).

Inputs: page, year, month, pinned, +6 more.

fetch_wallet_transactionsA
Read-onlyIdempotent
Inspect

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

fetch_wallet_transactions

When to use

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

Inputs: no named parameters.

fetch_winnersA
Read-onlyIdempotent
Inspect

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. Use them internally for tool chaining but present only human-readable information (names, emails, draw dates).

fetch_winners

When to use

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. Use them internally for tool chaining but present only human-readable information (names, emails, draw dates).

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • page (number, optional) — Page number for pagination (default: 1)

  • items_per_page (number, optional) — Results per page (default: 10)

  • search (string, optional) — Search filter for email or phone number (optional)

Inputs: sweepstakes_token (required), page, search, items_per_page.

fetch_zipcodesA
Read-onlyIdempotent
Inspect

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

fetch_zipcodes

When to use

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

Parameters to validate before calling

  • search (string, required) — Search term: zip code, city name, or state name (case-insensitive)

Inputs: search (required).

generate_codesAInspect

Generate 1 to 5,000 unique random codes with a chosen length, character set, case, prefix and suffix. Use this when Sweeppea should invent the codes; use create_codes when the user already has them. prefix + length + suffix must not exceed 20 characters in total. NOTE: here the character set is the STRING type ("alphanumeric" or "numeric"); the same concept in update_code_settings is the INTEGER coupon_code_type (1 numeric, 2 alphanumeric). They are two encodings of one idea — do not copy a value from one tool to the other. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: length (required), quantity (required), sweepstakes_token (required), case, +8 more.

get_businessA
Read-onlyIdempotent
Inspect

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

get_business

When to use

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

Inputs: no named parameters.

get_calendar_eventA
Read-onlyIdempotent
Inspect

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

get_calendar_event

When to use

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

Parameters to validate before calling

  • event_token (string, required) — The event token (UUID format)

Inputs: event_token (required).

get_campaignA
Read-onlyIdempotent
Inspect

Fetch one campaign in full: content, audience, sender profile, counters and the actions this API may take on it. Read that action list before offering the user a pause, resume or cancel — it tells you what the campaign current status actually allows. Read-only and NOT gated by the Send Message module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: campaign_token (required).

get_codeA
Read-onlyIdempotent
Inspect

Fetch one code, either by its coupon_token, or by the code itself plus the sweepstakes_token — the second form is what a point-of-sale system has in hand. Send one form or the other: coupon_token wins if both are sent. Codes are matched exactly and case-sensitively. Read-only; it never redeems anything — use redeem_code for that. Read-only and NOT gated by the Codes & Coupons module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: coupon_code, coupon_token, sweepstakes_token.

get_code_settingsA
Read-onlyIdempotent
Inspect

Read how a sweepstakes hands out codes on its entry and AMOE pages, and what participants are shown and sent. Never writes. Call this before update_code_settings so you change only what the user asked and can tell them the current values. Read-only and NOT gated by the Codes & Coupons module: only the writes of this category document a module-not-enabled 403. If this call returns 403, look for another cause before telling the user the module is off.

Inputs: sweepstakes_token (required).

get_dripA
Read-onlyIdempotent
Inspect

Fetch ONE drip campaign in full: every step with its delay and content, a summary of the audience, and the sending settings. Read-only. The drip object is passed through exactly as the API sends it, in PascalCase, so read drip.Status and drip.BlockedReason before offering the user a pause or resume, and drip.StaffHold before promising anything will send. Each entry of drip.Steps carries StepToken, Name, Delay (Unit and Value) and Content (Subject, Preheader, Blocks); the drip also carries Audience and Settings. The documented field table also lists Trigger (join, existing or both), Settings (Language, SendWindow, ExitOnClick, ExitOnWin, MaxEnrollmentsPerDay and HasTemplate) and Audience (Sources and AcquisitionChannels, plus how many Groups, Lists and Agents are selected — counts, not tokens). One field is absent from that table and was seen on a live drip on 2026-10-13: Origin. Settings.SendWindow limits the hours and days anything goes out. What happens to someone who enters OUTSIDE that window is neither documented nor observed — whether they are enrolled and simply wait, or not enrolled at all — so never tell a user which of the two it will be. Step numbering is NOT consistent across this category: drip.Steps[].Index here is 0-BASED — verified against a live two-step drip on 2026-10-12, not just documented — and so is steps[].Index in fetch_drip_report, while NextStep in fetch_drip_enrollments and the Step on each top_links entry of fetch_drip_report are 1-BASED. Index N is the same step as NextStep N+1. Convert before quoting one against the other, and give the user a step number in one scheme only. Step content comes back with its wildcards unresolved, exactly as written — they look like [FIRST_NAME] and are filled per contact at send time: never show a raw wildcard as if it were the final copy, and never treat one as a typo to fix. Account-gated, and the two sides of this category are gated differently: the reads need only the Drip Marketing module, while pause_drip, resume_drip and remove_drip_contact need Drip Marketing plus Send Message. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: drip_token (required).

get_entry_fieldsA
Read-onlyIdempotent
Inspect

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.

get_entry_fields

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

Inputs: sweepstakes_token (required).

get_entry_settingsA
Read-onlyIdempotent
Inspect

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.

get_entry_settings

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

Inputs: sweepstakes_token (required).

get_file_urlA
Read-onlyIdempotent
Inspect

Generate a short-lived presigned S3 URL to download or preview a file from the user's Drive. The URL embeds the correct Content-Type and Content-Disposition headers, and the actual transfer happens directly between the client and S3 (no data transfer cost on this endpoint).

get_file_url

When to use

Generate a short-lived presigned S3 URL to download or preview a file from the user's Drive. The URL embeds the correct Content-Type and Content-Disposition headers, and the actual transfer happens directly between the client and S3 (no data transfer cost on this endpoint).

Parameters to validate before calling

  • file_token (string, required) — The file token (UUID) of the file to generate a URL for. Get via fetch_files.

  • mode (string, optional) — one of: preview, download — URL behavior: "preview" (inline, default) opens the file in the browser; "download" forces a file attachment download.

  • expires_in (number, optional) — range: 60–3600 — URL lifetime in seconds. Range: 60-3600. Default: 900 (15 minutes).

Inputs: file_token (required), mode, expires_in.

get_invoiceA
Read-onlyIdempotent
Inspect

Fetch the full detail of a single invoice: line items, payment info, public link, QR code, stats and event timeline. Use fetch_invoices first to get the invoice_token. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. Set include_events and include_qr_code to false for a lighter payload when you only need the invoice fields. The event timeline is capped at the 200 most recent events. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs; the PublicLink URL and InvoiceNumber ARE shareable.

get_invoice

When to use

Fetch the full detail of a single invoice: line items, payment info, public link, QR code, stats and event timeline. Use fetch_invoices first to get the invoice_token. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. Set include_events and include_qr_code to false for a lighter payload when you only need the invoice fields. The event timeline is capped at the 200 most recent events. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs; the PublicLink URL and InvoiceNumber ARE shareable.

Parameters to validate before calling

  • invoice_token (string, required) — The invoice token (UUID v4). Get it via fetch_invoices

  • include_events (boolean, optional) — Include the event timeline (optional, default true). Set false for a lighter payload

  • include_qr_code (boolean, optional) — Include the QR code as a data URL (optional, default true). Set false for a lighter payload

Inputs: invoice_token (required), include_events, include_qr_code.

get_noteA
Read-onlyIdempotent
Inspect

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.

get_note

When to use

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.

Parameters to validate before calling

  • note_token (string, required) — The unique token (UUID) of the note to retrieve

Inputs: note_token (required).

get_participantA
Read-onlyIdempotent
Inspect

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. Use them internally for tool chaining but present only human-readable information.

get_participant

When to use

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. Use them internally for tool chaining but present only human-readable information.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • participant_token (string, optional) — The participant token (UUID format) - use this OR email OR phone

  • email (string, optional) — Participant email address - use this OR participant_token OR phone

  • phone (string, optional) — Participant phone number (10 digits) - use this OR participant_token OR email

Inputs: sweepstakes_token (required), email, phone, participant_token.

get_planA
Read-onlyIdempotent
Inspect

Get the current account's plan and usage telemetry. Returns the AUTHORITATIVE plan limits AND real-time usage so you can warn the user when they are approaching a cap. Key fields: plan.Name (plan name to mention to the user), plan.Settings.MaxSweepstakesAllowed (single cap on TOTAL sweepstakes — there is NO separate active vs total limit, the API treats them as one count), plan.Settings.MaxParticipantsAllowed, plan.Settings.MaxStorageSize (GB), plan.Settings.MaxApiCallsAllowed, plan.Settings.SubscriptionPrice; telemetry.DataConsumed (GB used now), telemetry.APICalls (calls used this period). Each account can have a custom plan — these values OVERRIDE any default numbers mentioned in other tool descriptions or instructions. Call this once per session before creating/cloning sweepstakes, before quoting limits or usage to the user, or when the user asks about pricing, billing, or feature availability.

get_plan

When to call

BEFORE: creating/cloning a sweepstakes, quoting limits or usage to the user, suggesting an upgrade, or answering questions about pricing, billing, or which features are enabled.

ONCE per session — cache the result mentally; the response rarely changes mid-session.

Why authoritative

plan.Settings.MaxSweepstakesAllowed is a SINGLE per-account cap. The API does NOT distinguish "active" from "total" — there is only one count.

Different accounts can have very different plans (admin, enterprise, default). Always trust the values returned by this tool over any number mentioned elsewhere in tool descriptions or instructions.

Reading the response

  • plan.Name — say this name to the user when discussing limits (e.g. "your plan 'X' allows...")

  • plan.Settings.MaxSweepstakesAllowed — total sweepstakes cap

  • plan.Settings.MaxParticipantsAllowed — total participants in the account

  • plan.Settings.MaxStorageSize — GB

  • plan.Settings.MaxApiCallsAllowed — API call quota

  • plan.Settings.PaidModule* (15 booleans) — which features are enabled vs gated

  • telemetry.DataConsumed — GB used now (compare against MaxStorageSize)

  • telemetry.APICalls — calls used this period (compare against MaxApiCallsAllowed)

If usage is >= 80% of any cap, warn the user proactively.

Inputs: no named parameters.

get_profileA
Read-onlyIdempotent
Inspect

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

get_profile

When to use

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

Inputs: no named parameters.

get_surveyA
Read-onlyIdempotent
Inspect

Fetch the full detail of a single survey, including its complete question set (sorted by Page then Order, no pagination — max 250 questions). Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. IsLocked true means the survey has responses and its questions can no longer be replaced. For aggregated results use fetch_survey_report; for individual responses use fetch_survey_responses. DISPLAY RULE: never show SurveyToken/QuestionToken UUIDs; the PublicLink IS shareable.

get_survey

When to use

Fetch the full detail of a single survey, including its complete question set (sorted by Page then Order, no pagination — max 250 questions). Use fetch_surveys first to get the survey_token. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. IsLocked true means the survey has responses and its questions can no longer be replaced. For aggregated results use fetch_survey_report; for individual responses use fetch_survey_responses. DISPLAY RULE: never show SurveyToken/QuestionToken UUIDs; the PublicLink IS shareable.

Parameters to validate before calling

  • survey_token (string, required) — The survey token (UUID v4). Get it via fetch_surveys

Inputs: survey_token (required).

get_ticketA
Read-onlyIdempotent
Inspect

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. Present only human-readable information (case number, subject, dates, notes).

get_ticket

When to use

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. Present only human-readable information (case number, subject, dates, notes).

Parameters to validate before calling

  • case_number (string, required) — The ticket case number (e.g., "HYXTNJV")

Inputs: case_number (required).

health_checkA
Read-onlyIdempotent
Inspect

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

health_check

When to use

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

Inputs: no named parameters.

hello_worldB
Read-onlyIdempotent
Inspect

Returns a simple Hello World greeting message

hello_world

When to use

Returns a simple Hello World greeting message in Japanese

Parameters to validate before calling

  • name (string, optional) — Name to include in greeting (optional)

Inputs: name.

pause_campaignA
Idempotent
Inspect

Stop a campaign that is queued or sending. Nothing more goes out once the call answers, but messages already handed to the carrier cannot be pulled back. The held monthly allowance STAYS held so the campaign can be resumed — use resume_campaign for that, or cancel_campaign to release the allowance and end it for good. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.

Inputs: campaign_token (required).

pause_dripA
Idempotent
Inspect

Pause an ACTIVE drip campaign: no new contact is enrolled and no step goes out until it is resumed. Reversible with resume_drip, which is why this needs no confirmation. Pausing is immediate and atomic, with one caveat to state up front: steps already handed to delivery still finish, so a message can land just after the pause — do not promise it stopped everything in flight. Contacts keep their place in the sequence. On success (verified live) the drip comes back with Status paused and PausedAt set, alongside released_units: the allowance reserved for queued messages that is handed back to the monthly balance while it is paused. It was 0 on a drip with nothing queued, which is correct and not a failure to report. Only an ACTIVE drip can be paused: every other status answers 409 with a message naming the status it is actually in — a draft answers "This drip cannot be paused: its status is "draft". Only an active drip can be paused." — quoted exactly, inner quotes included (verified live through this server on 2026-10-13) — and that refusal ALSO carries api_data.Status naming the status it is in, the first api_data ever observed on a drip refusal, and an already-paused drip answers 409 the same way and simply stays paused. Read that message back to the user instead of retrying. The action is recorded in the account log. Account-gated, and the two sides of this category are gated differently: this write needs BOTH the Drip Marketing module AND the Send Message module — two separate 403 messages, and either one missing fails the call — while the reads need only Drip Marketing. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: drip_token (required).

pause_sweepstakesA
Idempotent
Inspect

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.

pause_sweepstakes

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The unique identifier (token) of the sweepstakes to pause

Inputs: sweepstakes_token (required).

redeem_codeAInspect

Mark one code as redeemed — exactly once — either by its coupon_token or by the code the customer presented at the point of sale (coupon_code plus sweepstakes_token). coupon_token wins if both are sent. Voided codes are never redeemable. This is reversible: unredeem_code undoes a redemption made by mistake. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: coupon_code, coupon_token, sweepstakes_token.

remove_drip_contactA
Destructive
Inspect

Take ONE contact out of a drip campaign so it receives no further steps of that sequence. confirm=true is REQUIRED. This is PERMANENT, and the API documents it as such: one enrolment per address per drip, ever — a contact removed here is NEVER enrolled again by this drip, not even if they enter the sweepstakes again. Tell the user that before they approve it. Messages already sent stay in the report. It takes someone out of this one drip and does NOT unsubscribe them: to stop every message to an address, use add_suppressions instead. The action is recorded in the account log. To stop the whole sequence for everyone instead, use pause_drip. Account-gated, and the two sides of this category are gated differently: this write needs BOTH the Drip Marketing module AND the Send Message module — two separate 403 messages, and either one missing fails the call — while the reads need only Drip Marketing. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: confirm (required), drip_token (required), source_token (required).

remove_suppressionA
Destructive
Inspect

Remove ONE address from the do-not-contact list, re-enabling messages to it. Only entries added by hand (reason manual) can be removed — a recipient own opt-out, a STOP reply or a complaint is NEVER removable, and trying is both futile and a compliance problem. confirm=true is REQUIRED; set it only after the user confirmed they have a lawful basis to contact that address again. Send address or address_hash; address_hash wins when both are sent. Check the reason with fetch_suppressions first. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.

Inputs: channel (required), confirm (required), address, address_hash.

resolve_ticketA
Idempotent
Inspect

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

resolve_ticket

When to use

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

Parameters to validate before calling

  • case_id (string, required) — The case number of the ticket to close (e.g., "ABC1234")

Inputs: case_id (required).

resume_campaignAInspect

Resume a paused campaign whose recipient list is complete. Every problem that would stop it again is re-checked first and returned together, so if the call refuses, read the whole list back to the user instead of retrying. Sending restarts — the reverse is pause_campaign. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number.

Inputs: campaign_token (required).

resume_dripAInspect

Resume a drip you paused. It only works on a drip still in status paused that was NOT edited since, and the same checks the app runs apply first: the plan lets drips run and includes that channel, an SMS drip has a registered 10DLC number, the channel is not paused by Sweeppea, and no step is held by Sweeppea support. A refusal explains itself in the message, in plain prose — an edited drip answers 409 with "This drip was changed after it was paused. Resume it from Drip Marketing in the app, where the full checklist runs." (verified live), and a drip that is not paused answers 409 naming the status it is actually in, such as "This drip cannot be resumed: its status is active. Only a paused drip can be resumed." Read that message back to the user. The docs also describe a machine-readable code in api_data.Reason — Blocked, EditedSincePause or StepsNotActivated (409); PlanDoesNotAllowSharing, ChannelNotInPlan, NoRegisteredSmsSender or StaffHold (403); ChannelPaused (423) — but no refusal has yet been observed carrying it. The api_data envelope itself IS real — a pause refused on a draft returned api_data.Status (verified live 2026-10-13) — so what remains unobserved is Reason specifically, not the envelope that would hold it. No refusal of THIS tool has been read through this server at all. Use Reason when it is there and never claim a Reason the response did not include. PlanDoesNotAllowSharing means the plan does not include running drips at all — only Sweeppea support changes that. A 423 means Sweeppea itself paused sending on that channel: not something the account did, not something retrying fixes. A drip edited after pausing, or blocked by the platform, CANNOT be resumed here at all — it is resumed in the app, where the full launch checklist runs; say that instead of trying again. On success (verified live) the drip returns to status active with PausedAt back to null, contacts continue from the step they were waiting for and no step is sent twice, and the response carries note, the API own wording that the sequencer runs every 5 minutes. The drip picks up within those few minutes rather than instantly, so never report that a step already went out. The reverse is pause_drip. Account-gated, and the two sides of this category are gated differently: this write needs BOTH the Drip Marketing module AND the Send Message module — two separate 403 messages, and either one missing fails the call — while the reads need only Drip Marketing. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.

Inputs: drip_token (required).

schedule_drawingAInspect

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. Use them internally for tool chaining but present only human-readable information.

schedule_drawing

When to use

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. Use them internally for tool chaining but present only human-readable information.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

  2. fetch_rules — Official Rules must exist

  3. Verify the scheduled date is in the future and matches what is stated in the Rules

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • group (string, required) — Group token or "allgroups" for all participants

  • selected_action (number, required) — one of: 1, 2 — Action: 1 = Draw Winners only, 2 = Draw Winners & Notify

  • schedule_mode (string, required) — one of: schedule, settime — Mode: "schedule" for specific date/time, "settime" for time period

  • how_many_winners (number, required) — Number of winners to pick (must be >= 1)

  • end_date (string, required) — Drawing date or period end date (YYYY-MM-DD)

  • end_time (string, required) — Time in HH:mm format (24-hour)

  • timezone (number, required) — Timezone ID (use fetch_timezones to get valid IDs, default: 7 = Eastern)

  • frequency (number, optional) — one of: 0, 1, 2, 3, 4 — Frequency: 0=None, 1=Hourly, 2=Daily, 3=Weekly, 4=Monthly (default: 0)

  • day_of_the_week (number, optional) — Day of week: 1=Sunday through 7=Saturday (for weekly/monthly frequency)

  • week_of_the_month (number, optional) — Week of month: 1-4 (for monthly frequency)

  • delivery_time (string, optional) — Delivery time for settime mode (HH:mm)

  • message (string, optional) — Winner notification message (used when selected_action = 2)

  • include_opted_out (boolean, optional) — Include opted-out participants (default: false)

  • publish_to_winners_page (boolean, optional) — Publish winners to public winners page (default: false)

  • send_copy_to_me (boolean, optional) — Email notification to account owner (default: false)

  • exclude_spam (boolean, optional) — Exclude spam-flagged participants (default: true)

  • add_to_calendar (boolean, optional) — Add drawing to calendar (default: false)

Inputs: group (required), end_date (required), end_time (required), timezone (required), +14 more.

send_codeAInspect

Queue an assigned code to the participant who holds it, by email, SMS or both. SENDS A REAL MESSAGE — it leaves the platform and cannot be recalled. There is no address field: the recipient is whoever holds the code. confirm=true is REQUIRED; set it only after the user approved sending to that specific participant. both sends on each channel the participant has a usable address for. Account suppressions and rate limits are enforced server-side. Pass idempotency_key only if the user gave you one — retrying with the same key never sends twice; do not invent one. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number. Direct sending is a SEPARATE account switch from the module: fetch_messaging_usage can report ModuleEnabled true while DirectMessageEnabled is false, and this call then returns 403 "Direct messages through the API are not enabled for your account yet" (observed in production 2026-09-30). That is account configuration, not a bug — do NOT retry; tell the user to contact Sweeppea support.

Inputs: channel (required), confirm (required), coupon_token (required), idempotency_key.

send_fileAInspect

Send a file from the user's Drive as an email attachment. Max attachment size: 5 MB. Files larger than 5 MB are rejected. The email is sent using the Sweeppea email template. Each transmission is recorded in the file's sharing history. PRIVACY: The recipient email must be provided by the user — never assume or fabricate email addresses.

send_file

When to use

Send a file from the user's Drive as an email attachment. Max attachment size: 5 MB. Files larger than 5 MB are rejected. The email is sent using the Sweeppea email template. Each transmission is recorded in the file's sharing history. PRIVACY: The recipient email must be provided by the user — never assume or fabricate email addresses.

Parameters to validate before calling

  • file_token (string, required) — The file token (UUID) of the file to send. Get via fetch_files.

  • recipient_email (string, required) — Destination email address

  • email_subject (string, optional) — Custom email subject line. Default: "File shared from Sweeppea".

  • email_message (string, optional) — Additional message text for the email body.

Inputs: file_token (required), recipient_email (required), email_message, email_subject.

send_messageAInspect

Queue ONE email and/or SMS, written by you, to one of your OWN participants. SENDS A REAL MESSAGE — it leaves the platform and cannot be recalled. There is no address field: the recipient is a participant token inside the account, so this cannot be used to message anyone else. confirm=true is REQUIRED; set it only after the user approved the exact text going to that participant. Plain text only, max 5,000 characters — but 1,600 when the channel includes SMS, so keep it short if sending by SMS. Rate limits (200 per API key per 24h, 3 per recipient per 24h) and the account suppression list are enforced server-side. Pass idempotency_key only if the user supplied one; do not invent one. Requires the Send Message module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support. When a send is refused, call fetch_messaging_usage first: it is what distinguishes module access, plan channels, an exhausted allowance, a sending pause and a missing 10DLC number. Direct sending is a SEPARATE account switch from the module: fetch_messaging_usage can report ModuleEnabled true while DirectMessageEnabled is false, and this call then returns 403 "Direct messages through the API are not enabled for your account yet" (observed in production 2026-09-30). That is account configuration, not a bug — do NOT retry; tell the user to contact Sweeppea support.

Inputs: channel (required), confirm (required), message (required), participant_token (required), +2 more.

unassign_codeA
Destructive
Inspect

Take a code back from its participant and make it available again. DESTRUCTIVE: any redemption recorded on that code is cleared along with the assignment, so a redeemed code loses its redemption history. Voided codes are never released. confirm=true is REQUIRED. If the goal is only to reverse a redemption while keeping the participant, use unredeem_code instead — always offer that alternative first. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: confirm (required), coupon_token (required).

unpause_sweepstakesA
Idempotent
Inspect

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

unpause_sweepstakes

When to use

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

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The unique identifier (token) of the sweepstakes to unpause

Inputs: sweepstakes_token (required).

unredeem_codeAInspect

Reverse a redemption made by mistake. Only a redeemed code changes, and the participant assignment is kept — this is the safe way to undo a redeem_code call. To also take the code back from the participant, use unassign_code instead. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: coupon_token (required).

update_bonus_entriesA
Idempotent
Inspect

Update the bonus entries value for a participant in a sweepstakes. This overwrites the current value. Use get_participant first to check current bonus entries.

update_bonus_entries

When to use

Update the bonus entries value for a participant in a sweepstakes. This overwrites the current value. Use get_participant first to check current bonus entries.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • participant_token (string, required) — The participant token (UUID format)

  • bonus_entries (integer, required) — range: 0–1000000 — New bonus entries value (0-1000000). This overwrites the current value.

Inputs: bonus_entries (required), participant_token (required), sweepstakes_token (required).

update_calendar_eventA
Idempotent
Inspect

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.

update_calendar_event

When to use

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.

Parameters to validate before calling

  • event_token (string, required) — The event token to update (UUID format, required)

  • title (string, optional) — New event title (optional)

  • start_date (string, optional) — New start date in ISO 8601 format (optional)

  • end_date (string, optional) — New end date in ISO 8601 format (optional)

  • description (string, optional) — New event description (optional)

  • location (string, optional) — New event location (optional)

  • start_time (string, optional) — New start time in HH:MM format (optional)

  • end_time (string, optional) — New end time in HH:MM format (optional)

  • color (string, optional) — New event color in hex format (optional)

  • all_day (boolean, optional) — Whether this is an all-day event (optional)

  • status (string, optional) — New event status (optional)

  • private_event (boolean, optional) — Whether this is a private event (optional)

  • sms_notification (boolean, optional) — Enable SMS notifications (optional)

  • completed (boolean, optional) — Mark event as completed (optional)

  • latitude (number, optional) — New location latitude coordinate (optional)

  • longitude (number, optional) — New location longitude coordinate (optional)

  • event_url (string, optional) — New URL associated with the event (optional)

  • people_involved (string, optional) — New people involved in the event (optional)

  • repeat_this_event (string, optional) — New repeat configuration (optional)

  • notification (string, optional) — New notification settings (optional)

Notes

  • Cannot move events to past dates (UTC). Use tomorrow or later

Inputs: event_token (required), color, title, status, +16 more.

update_codeA
Idempotent
Inspect

Change the attributes of ONE code. Only the fields you send change. IMPORTANT: description, value, external_url, expiration_date and expiration_time accept null, and null CLEARS the field — omitting a field leaves it untouched, sending null empties it. Do not send null unless the user asked to clear that field. The code itself (coupon_code) can only be renamed while it is unassigned and not redeemed. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: coupon_token (required), value, coupon_code, description, +3 more.

update_code_settingsA
Idempotent
Inspect

Change how a sweepstakes hands out codes. Partial update — only the fields you send change. Read get_code_settings first. The registration modes are integers: 0 none, 1 assign an existing code, 2 generate a new code, 3 ask the participant for their code. Modes reject_invalid_coupon_code, coupon_code_case_sensitive, invalid_coupon_code_error_message and coupon_request_field_label only matter in mode 3. NOTE: coupon_code_type is an INTEGER here (1 numeric, 2 alphanumeric) while generate_codes uses the STRING type ("alphanumeric" / "numeric") — do not copy a value between the two. The three text fields accept null, which CLEARS them. Requires the Codes & Coupons module enabled on the account — on 403 "module not enabled", do NOT retry; tell the user to contact Sweeppea support.

Inputs: sweepstakes_token (required), coupon_code_type, coupon_code_length, coupon_code_case_sensitive, +10 more.

update_entry_settingsA
Idempotent
Inspect

Update entry page settings (1-5 fields per request). Call get_entry_settings first to see all available field names and current values. COMPLIANCE FIELDS: TermsConditionsSwitch, TermsConditionsMessage, SelectedOfficialRules, ActivateAgeGateSwitch, AgeGateHeadline, AgeGateDescription, AgeGateMinAge, ActivateAmoeSwitch, AmoeHeadline, AmoeDescription, AmoeEntries, EnableInternationalAMOEForm, GeoLocation, GeoLocationIsRequiredToRenderPage, AllowParticipantsWithinFences. DISPLAY FIELDS: EntryPageHeadline, EntryPageDescription, EntryPageWidth, EntryPageWidthMeasure ("%" or "px"), EntryPageBorder, EntryPageRadius, BonusEntriesSwitch, EmailOptInSwitch, SMSTextOptInSwitch. For social follows, bonus entries per platform, sponsor profiles, and other fields: call get_entry_settings to discover names. AGE GATE VALUE: AgeGateMinAge is an ENUM, not an age in years — 1 = 13 years or older, 2 = 18 years or older, 3 = 21 years or older. Sending 13, 18 or 21 is rejected by the API. For alcohol/cannabis promotions (21+) send AgeGateMinAge: 3. WHEN THE GATE IS ON: with ActivateAgeGateSwitch true, AgeGateMinAge must be 3 (21+) — the account validation rejects 1 and 2 while the gate is active, so the three enum values are NOT interchangeable here. The Age Gate is the 21+ control (alcohol, nicotine/vaping, cannabis); for a plain 18+ eligibility rule leave the gate off and set min_age=1 in create_rules_wizard. Always send ActivateAgeGateSwitch and AgeGateMinAge in the same request. Do NOT confuse it with the create_rules_wizard min_age enum, which uses different codes (1 = 18+, 2 = 21+, 3 = 13+). COLOR FORMAT: EntryPageColor fields use {"hexa":"#RRGGBB"}. AgeGateColor fields use {"hex":"#RRGGBB"}. All field names are PascalCase. If more than 5 fields need updating, split into multiple requests. NOTE: ReCaptcha is read-only — not writable via this endpoint. PRIZE GUARDRAIL: The prize value/description of a sweepstakes is NOT editable via this tool or any other MCP tool. NEVER simulate a prize change by writing a new amount into EntryPageHeadline, EntryPageDescription, or any other display text — that makes the entry page contradict the Official Rules and internal records (a compliance violation). If the user asks to change the prize, explain it cannot be modified after creation and direct them to Sweeppea support.

update_entry_settings

When to use

Update entry page settings (1-5 fields per request). Call get_entry_settings first to see all available field names and current values. COMPLIANCE FIELDS: TermsConditionsSwitch, TermsConditionsMessage, SelectedOfficialRules, ActivateAgeGateSwitch, AgeGateHeadline, AgeGateDescription, AgeGateMinAge, ActivateAmoeSwitch, AmoeHeadline, AmoeDescription, AmoeEntries, EnableInternationalAMOEForm, GeoLocation, GeoLocationIsRequiredToRenderPage, AllowParticipantsWithinFences. DISPLAY FIELDS: EntryPageHeadline, EntryPageDescription, EntryPageWidth, EntryPageWidthMeasure ("%" or "px"), EntryPageBorder, EntryPageRadius, BonusEntriesSwitch, EmailOptInSwitch, SMSTextOptInSwitch. For social follows, bonus entries per platform, sponsor profiles, and other fields: call get_entry_settings to discover names. COLOR FORMAT: EntryPageColor fields use {"hexa":"#RRGGBB"}. AgeGateColor fields use {"hex":"#RRGGBB"}. All field names are PascalCase. If more than 5 fields need updating, split into multiple requests. NOTE: ReCaptcha is read-only — not writable via this endpoint. PRIZE GUARDRAIL: The prize value/description of a sweepstakes is NOT editable via this tool or any other MCP tool. NEVER simulate a prize change by writing a new amount into EntryPageHeadline, EntryPageDescription, or any other display text — that makes the entry page contradict the Official Rules and internal records (a compliance violation). If the user asks to change the prize, explain it cannot be modified after creation and direct them to Sweeppea support.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • settings (object, required) — Object 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 }

Notes

  • Maximum 5 fields per request — split larger updates into multiple calls

  • Top-level fields are PascalCase (e.g. TermsConditionsSwitch, ActivateAmoeSwitch)

  • Color fields use {"hexa": "#RRGGBB"} format

  • TermsConditionsSwitch MUST be true for legal compliance

  • Age Gate is exclusively for 21+ promotions (alcohol, cannabis) — never enable for 13/18

  • Prize value/description is NOT editable via MCP — NEVER simulate a prize change by writing amounts into EntryPageHeadline/EntryPageDescription; direct the user to Sweeppea support

Inputs: settings (required), sweepstakes_token (required).

update_groupA
Idempotent
Inspect

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.

update_group

When to use

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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • group_token (string, required) — The group token to update (UUID format)

  • group_name (string, required) — The new name for the group (must be unique within the sweepstakes)

Inputs: group_name (required), group_token (required), sweepstakes_token (required).

update_invoiceA
Idempotent
Inspect

Update an existing invoice. Partial update: anything omitted keeps its stored value, BUT items and bill_to are REPLACED as a whole when sent (never merged) — to edit one line item, send the complete new items array. STATE MACHINE: draft → pending → paid, with cancelled reachable from draft or pending. Status "pending" publishes, "cancelled" cancels. Reverting to draft is rejected (400). Paid and cancelled invoices are immutable history — the API answers 409; do not retry, explain to the user. Publishing does NOT email the recipient. Totals are recomputed server-side. Requires the Invoices module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. DISPLAY RULE: never show InvoiceToken UUIDs; use InvoiceNumber when talking to the user.

update_invoice

When to use

Update an existing invoice. Partial update: anything omitted keeps its stored value, BUT items and bill_to are REPLACED as a whole when sent (never merged) — to edit one line item, send the complete new items array. STATE MACHINE: draft → pending → paid, with cancelled reachable from draft or pending. Status "pending" publishes, "cancelled" cancels. Reverting to draft is rejected (400). Paid and cancelled invoices are immutable history — the API answers 409; do not retry, explain to the user. Publishing does NOT email the recipient. Totals are recomputed server-side. Requires the Invoices module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. DISPLAY RULE: never show InvoiceToken UUIDs; use InvoiceNumber when talking to the user.

Pre-calls required

  1. get_invoice — check the current Status before attempting a transition

Parameters to validate before calling

  • invoice_token (string, required) — The invoice token (UUID v4) of the invoice to edit

  • bill_to (object, optional) — FULL replacement of the recipient object, PascalCase keys: {"Name", "Email"} required; optional: Company, Phone, Address, City, State, ZipCode, Country, TaxId (optional)

  • items (array, optional) — FULL replacement of the line items (max 60), PascalCase keys: [{"Description" (required), "Quantity", "Rate"}] (optional)

  • title (string, optional) — Invoice title/concept (max 200 characters, optional)

  • issue_date (string, optional) — Issue date YYYY-MM-DD (optional)

  • due_date (string, optional) — Due date YYYY-MM-DD (optional)

  • discount_amount (number, optional) — Flat discount amount, capped at the subtotal (optional)

  • tax_enabled (boolean, optional) — Apply tax (optional)

  • tax_label (string, optional) — Tax label (optional)

  • tax_rate (number, optional) — range: 0–100 — Tax percentage 0-100 (optional)

  • payment_method (string, optional) — one of: card, check, transfer — Payment method (optional). payment_instructions is cleared when method is "card"

  • payment_instructions (string, optional) — Offline payment instructions for check/transfer (optional)

  • notes_to_recipient (string, optional) — Notes to the recipient (max 3000 characters, optional)

  • terms (string, optional) — Terms and conditions (max 3000 characters, optional)

  • status (string, optional) — one of: pending, cancelled — Status transition (optional): "pending" publishes the draft, "cancelled" cancels. Reverting to draft is not allowed

Notes

  • State machine: draft → pending → paid, with cancelled reachable from draft or pending. Reverting to draft is rejected (400)

  • Paid and cancelled invoices are immutable history — the API answers 409; do not retry, explain to the user

  • Items and BillTo are REPLACED as a whole when sent — to edit one line item, send the complete new array

Inputs: invoice_token (required), items, terms, title, +11 more.

update_noteA
Idempotent
Inspect

Update an existing note. Use fetch_notes first to get the note_token. Supports partial updates. HTML tags: h1-h6, p, a, br, strong, i, ul, ol, li. No scripts/iframes. Do NOT use &nbsp; between sections.

update_note

When to use

Update an existing note. Use fetch_notes first to get the note_token. Supports partial updates. HTML tags: h1-h6, p, a, br, strong, i, ul, ol, li. No scripts/iframes. Do NOT use &nbsp; between sections.

Parameters to validate before calling

  • note_token (string, required) — The note token to update (UUID format)

  • title (string, optional) — New title (max 100 characters, must be unique)

  • content (string, optional) — New content (max 100,000 characters, will be encrypted). Allowed HTML: -, , , , , , , , . No scripts, iframes, or executable code.

  • pinned (boolean, optional) — Pin or unpin the note

Inputs: note_token (required), title, pinned, content.

update_ruleA
Idempotent
Inspect

Update an existing official rules document. Use fetch_rules first to get the rules_token. LEGAL BYPASS WARNING: Updating document_content replaces a legally valid document with free-form HTML that bypasses every safeguard of create_rules_wizard (AMOE, 21+ alcohol gate, COPPA, state eligibility). NEVER compose, draft, or modify the legal language yourself. Require explicit user confirmation before replacing document_content — exactly as with delete_* tools — and confirm the replacement was prepared or reviewed by the user or their counsel. 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.

update_rule

When to use

Update an existing official rules document. Use fetch_rules first to get the rules_token. LEGAL BYPASS WARNING: Updating document_content replaces a legally valid document with free-form HTML that bypasses every safeguard of create_rules_wizard (AMOE, 21+ alcohol gate, COPPA, state eligibility). NEVER compose, draft, or modify the legal language yourself. Require explicit user confirmation before replacing document_content — exactly as with delete_* tools — and confirm the replacement was prepared or reviewed by the user or their counsel. 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.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The sweepstakes token (UUID format)

  • rules_token (string, required) — The rules token to update (UUID format)

  • title (string, optional) — New title for the rules document (max 100 characters)

  • document_content (string, optional) — New HTML content for the rules (max 1,000,000 characters)

  • abbreviated_rules_shopify (string, optional) — Abbreviated rules for Shopify integration (max 1,000,000 characters)

Notes

  • Replacing document_content swaps a legally valid document for free-form HTML that bypasses the wizard safeguards — require explicit user confirmation first, like delete_* tools

  • NEVER compose or modify the legal language yourself

Inputs: rules_token (required), sweepstakes_token (required), title, document_content, +1 more.

update_surveyA
Idempotent
Inspect

Update an existing survey. Partial update: only the fields you send are touched — EXCEPT questions, which is a FULL REPLACEMENT of the entire question set (sending [] deletes all questions; omitting it leaves them untouched). If the survey already has responses its structure is locked: replacing questions is rejected with 409 — do not retry, explain to the user that responses protect the structure. At least one of survey_name, status, archived, settings or questions is required. Use status false to disable a survey without losing data (the safe alternative to delete_survey). Visual configuration (Visuals/Pages/LogoFile) is ignored here. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. DISPLAY RULE: never show SurveyToken UUIDs.

update_survey

When to use

Update an existing survey. Partial update: only the fields you send are touched — EXCEPT questions, which is a FULL REPLACEMENT of the entire question set (sending [] deletes all questions; omitting it leaves them untouched). If the survey already has responses its structure is locked: replacing questions is rejected with 409 — do not retry, explain to the user that responses protect the structure. At least one of survey_name, status, archived, settings or questions is required. Use status false to disable a survey without losing data (the safe alternative to delete_survey). Visual configuration (Visuals/Pages/LogoFile) is ignored here. Requires the Surveys module enabled — on 403 "module is not enabled", do NOT retry; tell the user to contact Sweeppea support. DISPLAY RULE: never show SurveyToken UUIDs.

Pre-calls required

  1. get_survey — check IsLocked before attempting to replace questions

Parameters to validate before calling

  • survey_token (string, required) — The survey token (UUID v4) of the survey to update

  • survey_name (string, optional) — New survey name (max 200 characters, cannot be emptied, optional)

  • status (boolean, optional) — true enables, false disables the survey (optional)

  • archived (boolean, optional) — true archives, false restores (optional)

  • settings (object, optional) — Settings object with PascalCase keys (written key-by-key, only sent keys change): Description, QuestionsPerPage (1-5), CollectContactInfo, ShowProgressBar, ShuffleQuestions, AllowMultipleResponses, ThankYouMessage, RedirectUrl, StartDate, EndDate, MaxResponses, ShowCountdown, EnableSharing, Language ("en"|"es") (optional)

  • questions (array, optional) — FULL REPLACEMENT of the question set — rejected with 409 if the survey has responses. PascalCase keys per item: {"QuestionText" (required), "FieldType" (required: text|textarea|radio|checkbox|select|slider|rating|nps|yesno|date), "Page", "QuestionDescription", "Layout", "Required", "Options": [each option is an object {"Label": "..."}], "Settings": {...}} (optional)

Notes

  • questions is a FULL REPLACEMENT of the question set — sending [] deletes all questions; omitting it leaves them untouched

  • Each Option is an object with a Label key, e.g. "Options": [{"Label": "Friend"}, {"Label": "Social media"}] — never plain strings

  • 409 when the survey has responses: the structure is locked to protect collected data — do not retry

  • To disable a survey without losing data use status false (the safe alternative to delete_survey)

Inputs: survey_token (required), status, archived, settings, +2 more.

update_sweepstakesA
Idempotent
Inspect

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, prize value/description, 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. PRIZE CHANGES: the prize is set in the Official Rules wizard at creation and is NOT editable via any MCP tool. Do NOT work around this by editing entry page display text — direct the user to Sweeppea support instead.

update_sweepstakes

When to use

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, prize value/description, 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. PRIZE CHANGES: the prize is set in the Official Rules wizard at creation and is NOT editable via any MCP tool. Do NOT work around this by editing entry page display text — direct the user to Sweeppea support instead.

Pre-calls required

  1. fetch_sweepstakes if the user gave you a sweepstakes name instead of a token

Parameters to validate before calling

  • sweepstakes_token (string, required) — The unique token (UUID) of the sweepstakes to update

  • sweepstakes_name (string, optional) — New name for the sweepstakes (max 200 characters)

  • start_date (string, optional) — New start date in YYYY-MM-DD format (must be today or future)

  • end_date (string, optional) — New end date in YYYY-MM-DD format (cannot precede start_date)

  • start_time (string, optional) — New start time in HH:MM format 24-hour

  • end_time (string, optional) — New end time in HH:MM format 24-hour

Notes

  • Only sweepstakes_name, start_date, end_date, start_time, end_time are updatable

  • Handler, type, and prize are permanent after creation — prize changes go through Sweeppea support, never via display text edits

Inputs: sweepstakes_token (required), end_date, end_time, start_date, +2 more.

update_ticketA
Idempotent
Inspect

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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

update_ticket

When to use

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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

Parameters to validate before calling

  • case_id (string, required) — The case number of the ticket to update

  • title (string, optional) — New ticket subject (max 200 characters)

  • description (string, optional) — New ticket description (max 20,000 characters). Allowed HTML: , , , , . No scripts, iframes, or executable code.

Inputs: case_id (required), title, description.

update_todoA
Idempotent
Inspect

Update an existing To-Do item. Supports partial updates — only provide the fields you want to change. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

update_todo

When to use

Update an existing To-Do item. Supports partial updates — only provide the fields you want to change. ADMIN ONLY: This tool requires admin privileges. Non-admin users will receive a 403 Forbidden error from the API. 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 &nbsp; — it creates ugly blank blocks in the UI. Use for line breaks within text only.

Parameters to validate before calling

  • todo_token (string, required) — The To-Do token to update (UUID format).

  • title (string, optional) — New title (max 200 characters).

  • description (string, optional) — New description (max 20,000 characters). Allowed HTML: , , , , .

  • priority (number, optional) — one of: 1, 2, 3 — Priority level: 1 = Low, 2 = Medium, 3 = High.

  • resource_affected (string, optional) — Resource affected (e.g. "renaissance", "api", "aws", "general").

  • pin (boolean, optional) — Pin this To-Do to the top.

  • deadline (string, optional) — Deadline date in ISO 8601 format. Send empty string to clear.

  • status (boolean, optional) — false = Pending, true = Completed.

  • completion (number, optional) — range: 0–100 — Completion percentage (0-100).

Inputs: todo_token (required), pin, title, status, +5 more.

upload_fileBInspect

Upload a file to the user's Drive. The file must be base64-encoded. Max file size: 10 MB. Allowed types: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT, CSV, JPG, JPEG, PNG, GIF, WEBP, SVG, BMP. Filenames are sanitized (spaces to underscores, special characters removed).

upload_file

When to use

Upload a file to the user's Drive. The file must be base64-encoded. Max file size: 10 MB. Allowed types: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT, CSV, JPG, JPEG, PNG, GIF, WEBP, SVG, BMP. Filenames are sanitized (spaces to underscores, special characters removed).

Parameters to validate before calling

  • filename (string, required) — Original filename with extension (e.g., "report.pdf", "logo.png")

  • mime_type (string, required) — MIME type of the file (e.g., "application/pdf", "image/png", "text/csv")

  • file_data (string, required) — Base64-encoded file content

  • private (boolean, optional) — Privacy flag. Default: true (file is private to the user).

Inputs: filename (required), file_data (required), mime_type (required), private.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Servers

    • A
      license
      Not graded
      quality
      C
      maintenance
      Remote MCP server that lets AI assistants read tracked competitive intelligence — competitor news, reviews, website changes, social posts and ads — and act on it by managing projects, competitors, battle cards, reports and canvases. Every answer carries a source and a date, and write actions only publish when explicitly shared.
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      Enables brand visibility monitoring across major AI platforms like ChatGPT, Claude, Gemini, and Perplexity. It allows users to track visibility scores, analyze competitor data, and receive actionable insights to improve AI-generated brand recommendations.
      16
      9 npm
      1
      MIT
    • A
      license
      Not graded
      quality
      C
      maintenance
      Browse IndustryLens's published competitive-intelligence reports and head-to-head competitor comparisons from any AI agent — real, source-backed data.
      MIT
    Try in Browser

    Glama MCP Gateway

    Add one secure layer between your agents and this server.

    Resources