<h2 id="usethecustomerapireference">Use the customer API reference</h2>The Revup API provides account, promotion, participant, entry, winner, and contact endpoints under <code>/api/v1</code>.Requests use an account API key in the required header and are limited by its scopes, promotion restrictions, and rate limits. Participant writes support idempotency so a safely retried request does not create duplicate work.Use the customer API reference at Account → API → Documentation or <code>/docs/api</code> for endpoint schemas and examples. Keep API secrets server-side and validate responses rather than depending on undocumented fields.

Understand authentication, scopes, rate limits, and the existing interactive API reference.

Revup API overview

Feedback

Roadmap

Changelog

Work with unified profiles, team access, billing, email sending, and the Revup API.

Audience, Account & API

Review account-level exports, import history, and administrative activity records.

Manage account exports and activity logs

Learn how Revup combines promotion, form, purchase, referral, message, and media activity into customer profiles.

Audience and unified customer profiles overview

Compare sending from revupmail.com with sending from your own domain, then set up and verify your sender.

Set up authenticated email sending

Understand plan access, read-only states, billing management, and profile capacity.

Manage billing and subscription access

Update the account name, company URL, logos, brand profile, and shared account details.

Manage company settings

Resolve a profile merge suggestion while preserving history and distinct people.

Merge duplicate profiles or keep them separate

Review cross-promotion history without confusing activity, identity, and consent.

Review profile activity, messages, media, and referrals

Create account-scoped API credentials with limited scopes and promotion access.

Create and manage Revup API keys

Find customer profiles and export a person’s contact data.

Search, filter, and export customer profiles

Add teammates to an account and grant only the product permissions their role needs.

Invite users and manage permissions

Update your profile, password, two-factor authentication, and trusted browsers.

Manage your personal profile and sign-in security

Manage people, entries, submissions, winner claims, exports, and performance.

Participants, Winners & Reporting

Manage an authorized claim extension and record when a prize has been delivered.

Extend a claim deadline and mark fulfillment

Prepare claim fields, legal-document settings, notifications, and translations.

Create a winner claim form

Record an ineligible winner and promote an alternate according to the official rules.

Disqualify or replace a winner

See how base, action, referral, payment, and purchase activity contribute to a participant total.

Understand entry totals and bonus entries

Request a participant export, monitor its preparation, and download it securely.

Export participants

Download reporting data and check the dates and totals before sharing it.

Export promotion reporting data

Correct verified participant information, validity, or integration delivery without hiding the history.

Fix a participant email, status, or delivery

Search participant records, inspect submissions and deliveries, and make authorized corrections.

View and manage participants

Work with prize drawings, existing winner records, eligibility, alternates, and lifecycle status.

Draw and manage winners

Send claim links, monitor responses and reminders, extend deadlines, and record fulfillment.

Notify winners and track claims

Understand metric definitions, product-specific reports, and changing totals.

Understand promotion reporting

Add participant records with explicit choices for updates, reporting, and follow-up.

Import participants from a CSV

Read participant, traffic, conversion, and engagement results for your Sweepstakes.

Understand Sweepstakes reporting

Understand participants, plays, winners, bonus plays, and your observed win rate.

Understand Instant Win reporting

Read participant, gallery, submission, and voting activity for your contest.

Understand Contest reporting

Understand qualifying orders, purchasers, sales, purchase entries, and free-entry results.

Understand Purchase Sweepstakes reporting

Connect Revup to Shopify and supported marketing platforms.

Integrations

Connect ActiveCampaign through the available authorization method and send participants to a selected list.

Connect ActiveCampaign

Connect Attentive and send eligible participant email or phone data with accurate channel consent.

Connect Attentive

Authorize Constant Contact, select a list, map fields, and test participant delivery.

Connect Constant Contact

Send Revup participants to HubSpot contacts with mapped properties and verified test delivery.

Connect HubSpot

Connect Klaviyo to a promotion, select a list, map fields, and verify a test participant.

Connect Klaviyo

Connect a Mailchimp account and send promotion participants to the correct audience with intentional field mappings.

Connect Mailchimp

Connect Omnisend, map participant data, and verify contact and subscription behavior.

Connect Omnisend

Configure a Postscript connection for eligible SMS contacts and verify consent-aware delivery.

Connect Postscript

Understand where Shopify is connected and how the account connection supports Purchase Sweepstakes.

Connect Shopify

Send participant events as JSON and understand the connector’s delivery limits.

Send participant data to a webhook

Send Revup participant events to Zapier and test the data used by downstream Zap actions.

Connect Zapier

Resolve common connection, mapping, consent, destination, and delivery problems.

Integration troubleshooting and FAQ

Match participant fields to compatible destination properties without misrepresenting consent.

Map Revup fields to integration fields

Learn how Revup connects promotions to supported email, SMS, CRM, ecommerce, Zapier, and webhook destinations.

Integrations overview and shared setup concepts

Restore expired authorization or remove a connected provider without overlooking affected promotions.

Reconnect or disconnect an integration

Inspect an integration failure, correct its cause, and retry the participant safely.

Retry a failed participant delivery

Use shared builder features, design, languages, publishing, security, email, SMS, and flows.

Build, Publish & Automate

Configure post-entry engagement actions and distribute or validate codes safely.

Add bonus actions, coupons, and passcodes

Make targeted visual adjustments without breaking mobile, accessibility, or future theme updates.

Use custom CSS safely

Set the heading and supporting description people see above your form fields.

Customize the form title and description

Configure images, theme colors, typography, and form layout.

Design a promotion with themes and brand settings

Copy a promotion for reuse or remove it with an understanding of what is and is not carried forward.

Duplicate or delete a promotion

Choose Revup-managed sending or your own domain, and understand what participants see when you email them.

Set up email sending for your account

Build trigger-based follow-up journeys for eligible promotion and form activity.

Automate email and SMS with Flows

Add contact, choice, rating, upload, payment, consent, and layout fields to a Revup form or promotion.

Add and configure form fields

Add a translated version and understand which settings remain shared.

Add languages and review translations

Control where, when, and how often a Revup popup appears.

Configure popup display rules

Choose a hosted page, inline widget, popup, or product-specific placement and test it on the final site.

Publish, embed, or share a promotion

Configure participant chat, custom FAQs, translated answers, and support contact details.

Configure RevAssist participant chat and FAQs

Choose the Revup protections that fit your promotion without creating unnecessary barriers for legitimate participants.

Configure security, CAPTCHA, geography, and entry limits

Add, remove, position, and test CAPTCHA protection on a Revup form.

Add CAPTCHA protection to a promotion

Allow promotion entry only from selected countries and understand how location access is evaluated.

Restrict promotion access with geofencing

Set entries-per-IP limits, block or allow specific IP addresses, and decide whether to block VPN and proxy connections.

Limit repeat entries and filter IP addresses

Control when a promotion opens and closes by setting its start date, end date, times, and time zone.

Set promotion dates and time zone

Understand what Strict, Medium, Low, Off, and Custom do before choosing a fraud-prevention preset.

Choose a promotion security level

Pre-fill a Revup-hosted or embedded form using URL parameters.

Pre-fill form fields with URL parameters

Keep a supported field out of the participant's view while still including it in a Revup form.

Hide a form field

Give participants additional entries when they provide a value in a supported form field.

Award bonus entries for a form field

Use consent fields to control when Revup sends mapped email and phone data to connected integrations.

Control integration syncing with email and SMS consent

Measure traffic from named campaigns without confusing tracking and referral links.

Create campaign tracking links

Turn qualifying Shopify orders into entries and show entry totals in your storefront.

Purchase Sweepstakes

Connect one Shopify store to a Revup account for Purchase Sweepstakes and storefront features.

Connect your Shopify store

Create a Shopify-connected promotion that awards entries for qualifying orders.

Create a Purchase Sweepstakes

Learn how Shopify orders become Revup participants and auditable purchase-entry records.

Import and understand Shopify orders

Show available or earned Purchase Sweepstakes entries across supported Shopify surfaces.

Install storefront, cart, checkout, and account entry displays

Set the base currency and calculation that converts qualifying Shopify spend into entries.

Configure entries per amount spent

Resolve common Shopify order, entry, product-rule, placement, referral, and refund issues.

Purchase Sweepstakes troubleshooting and FAQ

Verify Shopify, entry rules, order processing, storefront placements, refunds, and rules before launch.

Purchase Sweepstakes launch checklist

Configure product eligibility, bonus periods, order bonuses, and coupon bonuses.

Configure product rules, order bonuses, and coupon bonuses

Let participants share a store link and award entries when a referred purchase qualifies.

Enable purchase referral entries

Learn how refunds and corrected Shopify orders affect Purchase Sweepstakes entries.

Understand refunds and purchase-entry recalculation

Learn how Revup turns qualifying Shopify orders into sweepstakes entries and displays them across your store.

Purchase Sweepstakes overview

Restore a Purchase Sweepstakes connection or storefront publication without creating duplicate setup work.

Shopify permissions, reconnects, and installation recovery

Configure prizes, odds, winning codes, winner experiences, and claims.

Instant Win

Build an immediate-result promotion with prizes, entry fields, winner content, rules, and security.

Create an Instant Win promotion

Configure winning and losing code lists, reuse limits, and unmatched-code behavior.

Use unique winning and losing codes

Customize all four Instant Win games without changing prize allocation.

Configure spin-to-win, scratch-off, and result content

Resolve common prize, code, result, attempt, and claim issues.

Instant Win troubleshooting and FAQ

Learn how prizes, availability, winner experiences, codes, claims, and reporting work in Revup Instant Win.

Instant Win overview

Understand Scheduled Wins, daily limits, retry timing, and unawarded inventory.

Understand winner pacing and prize exhaustion

Set prize quantities, allocation, and winner-facing details.

Add Instant Win prizes and control availability

Review awarded prizes, notify winners, collect claims, manage deadlines, and track fulfillment.

Manage Instant Win winners and claims

Create branded forms for lead capture, registrations, payments, applications, and feedback.

Forms

Build a branded Revup form, configure its submission experience, and publish it as a page, embed, or popup.

Create and publish a form

Configure accepted files, upload limits, and contest-specific photo and video submissions.

Collect file uploads through a form

Resolve common validation, submission, upload, payment, embed, and integration issues.

Form troubleshooting and FAQ

Connect Stripe and configure USD one-time or recurring payment options.

Accept payments through a form

Learn what you can collect with Revup Forms and how submissions, payments, files, automations, and profiles work.