Run sweepstakes with Sweeppea: participants, winners, codes, official rules, messaging and surveys.
Explore 98 workflow actions for Sweeppea, including account permissions and operation limits.
48 read actions50 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add Messaging Suppressions
Write
Add up to 500 addresses of one channel to the account's do-not-contact list.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add Participant
Write
Add a new participant to a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign Code
Write
Assign one available code to one named participant (regular or AMOE) of the same sweepstakes who holds no code yet.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel Messaging Campaign
Write
Cancel a campaign that has not finished and release the monthly allowance it was holding.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clone Sweepstakes
Write
Clone an existing sweepstakes into a new one with a new handler, name, and dates.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Count Participants
Read
Get participant counts for a sweepstakes, broken down by collection type (Participants, AMOE, OptOuts) with optional date range filtering.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Create Calendar Event
Write
Create a new calendar event.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Codes
Write
Add 1 to 1,000 codes you already have (from a POS, a CRM or a printed batch) to a sweepstakes, with shared attributes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Group
Write
Create a new participant group within a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Note
Write
Create an encrypted personal note.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Rules (Wizard)
Write
Create official rules using a step-by-step wizard with structured form fields.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Rules Document
Write
Create an official rules document for a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Support Ticket
Write
Create a new support ticket.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Survey
Write
Create a survey together with its whole question set in one call.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Sweepstakes
Write
Create a new sweepstakes campaign.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create To-Do
Write
Create a new To-Do task item.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Calendar Event
Write
Permanently delete a calendar event.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Codes
Write
Delete 1 to 1,000 codes that nobody holds yet.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Group
Write
Delete a participant group.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Note
Write
Permanently delete a note.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Participant
Write
Permanently delete a participant from all collections (Participants, AMOE, OptOuts) within a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Rules
Write
Permanently delete a rules document.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Scheduled Drawing
Write
Cancel and delete a previously scheduled winner drawing.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Survey
Write
Permanently delete a survey with its questions, responses, statistics and uploaded media.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Sweepstakes
Write
Permanently delete a sweepstakes and all associated data (participants, entry pages, statistics, groups, rules, calendar events, short links, coupons, automations).
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Ticket
Write
Permanently delete a support ticket.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Draw Winners
Write
Randomly draw winners from eligible participants using a weighted algorithm (bonus entries increase selection probability).
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Drip Campaign Report
Read
Message statistics of a drip campaign: per step, in total, day by day, and the links people clicked.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch All Notes
Read
Retrieve all notes for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch All Sweepstakes
Read
Retrieve all sweepstakes belonging to the authenticated user, including full settings.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Area Codes
Read
Retrieve US telephone area codes with associated state and region data.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Billing Transactions
Read
Retrieve all billing transactions for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Business Info
Read
Retrieve the authenticated user's business information.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Calendar Events
Read
Retrieve all calendar events for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Closed Tickets
Read
Retrieve all closed/resolved support tickets for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Code Settings
Read
Read how a sweepstakes hands out codes on its entry and AMOE pages and what participants are shown and sent.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Code Statistics
Read
Count the codes of a sweepstakes: total, assigned, unassigned, redeemed, voided and available.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Codes
Read
One page of a sweepstakes' codes, filtered, searched and sorted on the server, with the participant each code is assigned to.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Consumptions
Read
Retrieve monthly and yearly consumption totals aggregated from billing transactions and data transfers.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Countries
Read
Retrieve a complete list of countries with ISO codes and names.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Data Transfer
Read
Retrieve data transfer billing logs for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Documentation
Read
Retrieve API documentation content programmatically for LLM integration or custom help systems.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Entry Page Fields
Read
Retrieve the form fields configured for a sweepstakes entry page.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Groups
Read
Retrieve all participant groups for a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Messaging Campaign Recipients
Read
List who a campaign went to and what happened to each message, paginated, with a status filter and an exact-address search.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Messaging Campaign Report
Read
Delivery report of one campaign: counters, rates over sent, messages by status, top error codes, sends per hour and most-clicked links.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Messaging Campaigns
Read
List the account's email and SMS campaigns, newest first, with filters and pagination.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Messaging Suppressions
Read
List the account's do-not-contact list: every address that unsubscribed, replied STOP, complained, bounced or was added by you.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Messaging Usage
Read
Read the account's messaging state: module access, plan channels, this month's email and SMS allowance, SMS sender readiness and any active sending pause.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Open Tickets
Read
Retrieve all open support tickets for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Participants
Read
Retrieve participants for a sweepstakes with pagination, search, and date filtering.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Plan Details
Read
Retrieve the current subscription plan details including limits, pricing, and enabled modules.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Profile Info
Read
Retrieve the authenticated user's profile information including personal data and account status.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Rules
Read
Retrieve all rules documents associated with a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Scheduled Drawings
Read
Retrieve all scheduled drawings for a sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Code
Read
Fetch one code by its CouponToken, or by the code itself within a sweepstakes (what a point-of-sale system has in hand).
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Event
Read
Retrieve a single calendar event by its token.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Messaging Campaign
Read
Fetch one campaign in full: content, audience, sender profile, counters and the actions this API may take on it.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Participant
Read
Retrieve a single participant by token, email, or phone number.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Survey
Read
Retrieve one survey with its complete question set, ordered by page and position, plus the IsLocked flag that says whether the structure can still be replaced.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Single Ticket
Read
Retrieve full details of a single support ticket including all notes and history.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Survey Report
Read
Retrieve the aggregated report of a survey: funnel totals, completion rate and times, device and browser breakdowns, daily timeline and per-question answer distributions.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Survey Responses
Read
Retrieve the individual answers collected by a survey, newest first and paginated.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Surveys
Read
List the surveys of the account with their question, page and response counters, plus the public HUB link of each one.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Timezones
Read
Retrieve a list of all supported timezones with their IDs and offsets.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch To-Do's
Read
Retrieve all To-Do tasks with optional filtering and pagination.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch US States
Read
Retrieve a list of all US states with codes and names.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Wallet Transactions
Read
Retrieve all wallet transactions (credits and debits) for the authenticated user.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Winners
Read
Retrieve all drawn winners for a sweepstakes with pagination and search.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Fetch Zip Codes
Read
Search and retrieve US zip code data.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Generate Codes
Write
Generate 1 to 5,000 unique random codes in a sweepstakes, with a chosen length, character set, case, prefix and suffix.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get Drip Campaign
Read
Returns one drip campaign in full: every step with its delay and content, a summary of the audience and the sending settings.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Health Check
Read
Verify that the API is healthy and the provided Bearer token is valid.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
List Drip Campaigns
Read
Lists the drip campaigns (automated email or SMS sequences) of your account, with their status, people counters and your plan allowance.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
List Drip Enrollments
Read
Lists the contacts enrolled in a drip campaign: where each one is in the sequence and why anyone left.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
Pause Drip Campaign
Write
Pauses an active drip campaign: no new contact is enrolled and no step is sent until it is resumed.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause Messaging Campaign
Write
Stop a campaign that is queued or sending.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause Sweepstakes
Write
Pause an active sweepstakes, temporarily stopping new entries.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Redeem Code
Write
Mark one code as redeemed , exactly once , by its token or by the code a customer presented (point of sale).
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove Contact From Drip
Write
Takes one contact out of a drip campaign so it receives no more steps.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resolve Ticket
Write
Mark a support ticket as resolved/closed.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resume Drip Campaign
Write
Resumes a drip campaign you paused, provided nothing has changed since and the account can still send.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resume Messaging Campaign
Write
Resume a paused campaign whose recipient list is complete.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Schedule Drawing
Write
Schedule an automated winner drawing for a future date and time, with optional recurring frequency.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send Code to Participant
Write
Queue an assigned code to the participant who holds it, by email, SMS or both, through the Messaging Engine.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send Message to Participant
Write
Queue one email and/or SMS written by you to one of your own participants.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unassign Code
Write
Take a code back from its participant and make it available again; any redemption is cleared with it.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unpause Sweepstakes
Write
Resume a previously paused sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unredeem Code
Write
Reverse a redemption made by mistake.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Calendar Event
Write
Update an existing calendar event.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Code
Write
Change the attributes of one code.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Code Settings
Write
Change how a sweepstakes hands out codes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Group
Write
Rename a participant group.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Note
Write
Update an existing note's title, content, or pinned status.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Rules
Write
Update an existing rules document title or content.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Survey
Write
Update a survey.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Sweepstakes
Write
Update one or more fields of an existing sweepstakes.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Ticket
Write
Add a note or update details on an existing support ticket.
Permissions and limits
Account permissions
A Sweeppea API token (Sweeppea dashboard, API Dashboard, API Keys)
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Sweeppea. A saved workflow is not a completed provider action.