Skip to main content

EasyPromos

EasyPromos is a self-service platform for creating and managing online promotions, contests, giveaways, and gamified campaigns. It offers 50+ promotion types — sweepstakes, quizzes, coupon redemptions, instant wins, and loyalty campaigns — deployable as microsites, embeds, or web apps. Its REST API manages promotions, participant data, participations, and prize assignments.

EasyPromos icon

Power end-to-end data operations for your EasyPromos API with Nexla. Our bi-directional EasyPromos connector is purpose-built for EasyPromos, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to EasyPromos or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your EasyPromos workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to EasyPromos, you need an active EasyPromos account with API access. The EasyPromos REST API is available exclusively to customers on the White Label or Corporate plan. If your account is on a lower-tier plan, you will need to upgrade before generating API credentials.

Obtain an EasyPromos API Key

EasyPromos authenticates API requests using Bearer tokens generated within the EasyPromos application. Follow the steps below to create a token for use in Nexla.

  1. Log in to your EasyPromos account at easypromosapp.com.

  2. Navigate to Settings > Integrations > Developers. Alternatively, you can access the Developers section from the Utilities dropdown menu in your account.

  3. On the Developers page, click Create new token to generate a new API token.

  4. By default, newly created tokens have a 30-day expiration. To extend the token's validity, click the Pencil (edit) icon next to the token and select a longer duration from the Extend by dropdown — options include up to one year.

  5. Copy the generated token and store it securely. This token will be used as the API Key when configuring the credential in Nexla.

EasyPromos API tokens are sensitive credentials — treat them like passwords and do not share them publicly. If a token is compromised, return to Settings > Integrations > Developers in your EasyPromos account to revoke it and generate a new one.

API Plan Requirement

The EasyPromos REST API is only available on the White Label or Corporate plan. Attempting to authenticate with an account on a lower-tier plan will result in authorization errors.

For additional details on token management, refer to the EasyPromos API reference and the Getting started with the Easypromos REST API guide.

Authenticate

Credentials required

Authenticate using an API key passed as a Bearer token in the Authorization header.

FieldRequiredSecretDescription
API KeyYesYesYour EasyPromos API key for authentication.
Base URLYesNoThe base URL for the EasyPromos API. Allowed values: Production

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your EasyPromos API token in the API Key field. This token authenticates all requests Nexla makes to the EasyPromos API on your behalf and is transmitted as a Bearer token in the Authorization request header.

  4. The Base URL field is pre-populated with the default EasyPromos API endpoint: https://api.easypromos.com. This is the correct production URL for all EasyPromos API calls and should not be changed unless directed by EasyPromos support.

    The Base URL dropdown includes a single Production option (https://api.easypromos.com). Select this option to connect to the live EasyPromos environment.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the EasyPromos connector tile, then select the credential that will be used to connect to the EasyPromos instance, and click Next; or, create a new EasyPromos credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common EasyPromos endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Promotions

Returns a paginated list of all promotions in your EasyPromos account. Use this endpoint to retrieve a full inventory of your campaigns, optionally filtered by status (e.g., active, inactive, or draft).

  • In the Status field, optionally enter a status value to filter the results. Accepted values include active, inactive, and draft. Leave this field empty to retrieve promotions in all statuses.
  • In the Order field, optionally specify the field by which results should be sorted (e.g., created_at or name). Leave this field empty to use the default sort order.

This endpoint uses cursor-based pagination, so Nexla will automatically retrieve all pages of results. The response data path is $.items[*], and pagination is managed via the next_cursor field in the $.paging object.

Get Promotion

Retrieves the full details of a single promotion identified by its unique ID. Use this endpoint when you need metadata and configuration details for a specific campaign.

  • In the Id field, enter the unique identifier of the promotion you want to retrieve. You can find promotion IDs by first running the List Promotions endpoint.

This endpoint returns a single promotion object. The response data path is set to $ (the root of the response).

List Organizing Brands

Returns a paginated list of all organizing brands associated with your EasyPromos account. Organizing brands are entities (companies or brands) that own and run promotions within your account.

  • In the Order field, optionally specify the field by which results should be sorted. Leave this field empty to use the default sort order.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results using the next_cursor field in the response.

Get Organizing Brand

Retrieves the details of a single organizing brand by its unique ID. Use this endpoint to access configuration and metadata for a specific brand within your EasyPromos account.

  • In the Id field, enter the unique identifier of the organizing brand you want to retrieve. You can find brand IDs by first running the List Organizing Brands endpoint.

List Brand Promotions

Returns a paginated list of promotions belonging to a specific organizing brand, with optional filtering by status. Use this endpoint when you need to scope your promotion data to a single brand.

  • In the Brand Id field, enter the unique identifier of the organizing brand whose promotions you want to retrieve. You can find brand IDs using the List Organizing Brands endpoint.
  • In the Status field, optionally enter a status value to filter results. Accepted values include active, inactive, and draft.
  • In the Order field, optionally specify the field by which results should be sorted.

This endpoint uses cursor-based pagination. Nexla will automatically retrieve all result pages.

List Participation Stages

Returns a list of all participation stages within a promotion. Stages define the individual steps or activities that participants must complete within a multi-step campaign. Use this endpoint to retrieve stage configuration and activity definitions for a promotion.

  • In the Id field, enter the unique identifier of the promotion whose stages you want to list.
  • In the Order field, optionally specify the field by which results should be sorted.
  • In the Segments field, optionally filter stages by specific audience segments.
  • In the Active field, optionally filter by active status. Enter true to return only active stages or false to return inactive stages.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

Get Participation Stage

Retrieves complete data for a single participation stage within a promotion. Use this endpoint when you need the full configuration and requirements for a specific stage.

  • In the Promotion Id field, enter the unique identifier of the promotion that contains the stage.
  • In the Id field, enter the unique identifier of the participation stage to retrieve.

List Promotion Users

Returns a paginated list of all users registered in a promotion, with optional filtering by registration status. Use this endpoint to retrieve your full participant list for a campaign.

  • In the Id field, enter the unique identifier of the promotion whose users you want to list.
  • In the Status field, optionally filter by participant status. Accepted values include pending, confirmed, and rejected.
  • In the Order field, optionally specify the field by which results should be sorted.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results using the next_cursor field in the $.paging object.

Get Promotion User

Retrieves all data for a single user registered in a specific promotion. Use this endpoint when you need the complete profile and activity record of an individual participant.

  • In the Promotion Id field, enter the unique identifier of the promotion.
  • In the Id field, enter the unique identifier of the promotion user you want to retrieve.

Get User Login Token

Retrieves the login token for a specific user registered in a promotion. Login tokens are used to authenticate users for operations such as submitting participations, checking eligibility, and managing segments on their behalf.

  • In the Promotion Id field, enter the unique identifier of the promotion.
  • In the User Id field, enter the unique identifier of the user whose login token you want to retrieve.

The login token returned by this endpoint is required as the lt parameter for several write-oriented EasyPromos endpoints, including segment assignment, participation submission, and eligibility checks. Retrieve the token here before configuring those destination endpoints.

List participations for a promotion

Returns a paginated list of all participation records for a promotion. Use this endpoint to retrieve the complete participation history for a campaign, including submitted entries and their associated data.

  • In the Promotion ID field, enter the unique identifier of the promotion whose participation records you want to retrieve.
  • In the Order field, optionally specify a sort field for the results.
  • In the Format field, optionally specify the response format for participation data.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

List participations for a user

Returns a paginated list of all participations submitted by a specific user within a promotion. Use this endpoint when you need a per-user participation history within a given campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose participation history you want to retrieve.
  • In the Order field, optionally specify a sort field for the results.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results.

Get a participation

Retrieves the complete details of a single participation record. Use this endpoint when you need to inspect the full data submitted for a specific participation entry.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Participation ID field, enter the unique identifier of the participation record you want to retrieve.

Get remaining participations for a user

Retrieves the remaining participation count available to a specific user within a particular promotion stage. Use this endpoint to check how many more times a user can participate before reaching the stage limit.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Stage ID field, enter the unique identifier of the promotion stage for which you want to check the remaining count.
  • In the User ID field, enter the unique identifier of the user to check.

List assigned prizes and winners

Returns the complete list of all assigned prizes and their corresponding winners for a promotion. Use this endpoint to retrieve prize distribution records, verify winner assignments, or export results for reporting purposes.

  • In the Promotion ID field, enter the unique identifier of the promotion whose prize and winner data you want to retrieve.

This endpoint uses cursor-based pagination. Nexla automatically retrieves all pages of results. For additional details, refer to the EasyPromos Prizes API documentation.

Get user prizes

Returns all prizes won by a specific user in a promotion. Use this endpoint to retrieve a single participant's complete prize history within a campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose prizes you want to retrieve.

For additional details, refer to the EasyPromos Prizes API documentation.

Get prize inventory

Returns prize inventory details including current stock levels for a promotion. Use this endpoint to monitor prize availability and ensure that sufficient inventory exists before distributing rewards.

  • In the Promotion ID field, enter the unique identifier of the promotion whose prize inventory you want to retrieve.

For additional details, refer to the EasyPromos Prizes API documentation.

Get user coin balance

Returns the current virtual coin balance for a specific user in a promotion. EasyPromos supports virtual coin economies within gamified campaigns, allowing users to earn and spend coins based on their participation. Use this endpoint to retrieve a user's current balance.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose coin balance you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

List user coin transactions

Returns the complete list of virtual coin transactions for a specific user in a promotion. Use this endpoint to audit a user's coin earning and spending history within a gamified campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose coin transaction history you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

List promotion coin transactions

Returns the complete list of all virtual coin transactions across all users in a promotion. Use this endpoint to get a full audit trail of coin activity for an entire campaign.

  • In the Promotion ID field, enter the unique identifier of the promotion whose coin transactions you want to retrieve.

For additional details, refer to the EasyPromos Coins API documentation.

Get promotion ranking

Returns the leaderboard ranking of users in a promotion based on their performance metrics (such as coin totals, participation counts, or other campaign-specific scoring). Use this endpoint to retrieve ranking data for display or downstream analysis.

  • In the Promotion ID field, enter the unique identifier of the promotion whose ranking data you want to retrieve.

For additional details, refer to the EasyPromos Rankings API documentation.

List points of sale

Returns the list of all points of sale associated with a promotion. Points of sale are physical or virtual retail locations linked to a campaign for location-based promotions or in-store redemption workflows.

  • In the Promotion ID field, enter the unique identifier of the promotion whose points of sale you want to retrieve.

For additional details, refer to the EasyPromos Points of Sale API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

EasyPromos data sources can also be manually configured to ingest data from any valid EasyPromos API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

The base URL for the EasyPromos API is https://api.easypromos.com. EasyPromos list endpoints (such as List Promotions or List Promotion Users) return records nested under an items key with pagination metadata in a paging key — use $.items[*] as the Path to Data for paginated endpoints and $.paging as the Path to Metadata to preserve cursor and count context. For single-object endpoints (such as Get Promotion), use $ as the Path to Data. Nexla automatically applies the Authorization header from your EasyPromos credential, so it does not need to be added manually. For a full list of available endpoints, see the EasyPromos API 2.0 reference.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new EasyPromos data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the EasyPromos destination, and select the Send to Destination option from the menu. Select the EasyPromos connector from the list of available destination connectors, then select the credential that will be used to connect to the EasyPromos organization, and click Next; or, create a new EasyPromos credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common EasyPromos endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Assign segments to a user

Assigns one or multiple segments to a user in a promotion. Use this endpoint to tag participants with audience segments for targeting, personalization, or eligibility-based filtering within your EasyPromos campaigns.

  • In the Promotion ID field, enter the unique identifier of the promotion in which the segment assignment will be made.
  • In the Login Token field, enter the user's login token. This token identifies the specific participant to whom the segments will be assigned. Login tokens can be retrieved using the Get User Login Token source endpoint.

The request body should include the segment identifiers to assign, provided as a JSON payload. Segments help EasyPromos campaigns filter, personalize, or restrict participation for specific audiences. For the required request body structure, refer to the EasyPromos API 2.0 reference.

Remove segments from a user

Removes one or multiple segments from a user in a promotion. Use this endpoint when a participant's segment membership needs to be revoked — for example, after a campaign phase ends or a user's eligibility status changes.

  • In the Promotion ID field, enter the unique identifier of the promotion from which the segment assignments will be removed.
  • In the Login Token field, enter the user's login token. Login tokens can be retrieved using the Get User Login Token source endpoint.

The request body should include the segment identifiers to remove, provided as a JSON payload. For the required request body structure, refer to the EasyPromos API 2.0 reference.

Autologin user

Logs in or registers a user in a promotion with optional user data and segment assignments in a single call. Use this endpoint to seamlessly integrate your own user registration system with EasyPromos, enabling users to participate without needing to register separately within the promotion.

  • In the Promotion ID field, enter the unique identifier of the promotion in which the user will be logged in or registered.

The Autologin endpoint allows you to pass user profile data (such as name and email) and pre-assign segments in the request body. If the user already exists in the promotion, they will be logged in; if not, a new participant record will be created. For the required request body structure, refer to the EasyPromos Autologin API documentation.

Check stage eligibility

Checks whether a user meets the requirements to participate in a specific promotion stage. Use this endpoint to validate a participant's eligibility before submitting a participation entry or unlocking a stage.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Stage ID field, enter the unique identifier of the promotion stage for which eligibility should be checked.
  • In the Login Token field, enter the user's login token. Login tokens can be retrieved using the Get User Login Token source endpoint.

The request body may include any requirement-specific data needed to validate eligibility. For the required structure, refer to the EasyPromos API 2.0 reference.

Validate participation code

Validates a code as a participation requirement for a promotion stage. Use this endpoint in coupon-code or ticket-code promotion workflows, where users must submit a valid code to unlock their participation entry.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Stage ID field, enter the unique identifier of the promotion stage for which the code will be validated.

The request body should include the code to validate. For the required structure, refer to the EasyPromos API 2.0 reference.

Submit participation

Submits a new participation entry for a user in a promotion stage. Use this endpoint to programmatically record participant entries — for example, when integrating EasyPromos with an external form, loyalty system, or data pipeline that captures user activity.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the Stage ID field, enter the unique identifier of the promotion stage in which the participation will be submitted.
  • In the Login Token field, enter the login token of the user submitting the participation. Login tokens can be retrieved using the Get User Login Token source endpoint.
  • In the Requirement field, optionally enter the value for the X-Requirement request header. This header identifies which stage requirement is being satisfied by the submission.

The request body should contain any participation data required by the stage (such as form answers, file uploads, or activity metrics). For the required structure, refer to the EasyPromos API 2.0 reference.

Update user coin balance

Updates the virtual coin balance for a specific user in a promotion. Use this endpoint to set or adjust a participant's coin total — for example, when awarding coins based on external activity tracked in another system.

  • In the Promotion ID field, enter the unique identifier of the promotion.
  • In the User ID field, enter the unique identifier of the user whose coin balance you want to update.

The request body should contain the updated coin balance value. For the required structure, refer to the EasyPromos Coins API documentation.

Create coin transaction

Creates a new coin transaction to add or remove virtual coins for a user in a promotion. Use this endpoint to credit or debit coins based on user activity recorded in external systems, such as purchases, referrals, or completed tasks tracked outside EasyPromos.

  • In the Promotion ID field, enter the unique identifier of the promotion in which the coin transaction will be created.

The request body should include the user ID, the transaction amount (positive to add coins, negative to remove coins), and any optional description. For the required structure, refer to the EasyPromos Coins API documentation.

Manual configuration

EasyPromos destinations can also be manually configured to send data to any valid EasyPromos API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

EasyPromos expects JSON for all write operations. The base URL is https://api.easypromos.com; for operations that target a specific resource (such as updating a user's coin balance), include the relevant IDs in the URL path. Some participation endpoints (e.g., Submit participation) require an X-Requirement request header to identify which stage requirement is being satisfied — add this in the Request Headers field. Nexla automatically applies the Authorization header from your EasyPromos credential, so it does not need to be added manually.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured EasyPromos endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the EasyPromos endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.