Skip to main content

EasyPromos Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an EasyPromos location.
easypromos_api.png

EasyPromos

Create an EasyPromos Destination​

  1. Click the + icon on the Nexset that will be sent to the EasyPromos destination, and select the Send to Destination option from the menu.

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

  3. In Nexla, EasyPromos destinations can be created using pre-built endpoint templates, which expedite destination setup for common EasyPromos write operations. Each template is designed specifically for the corresponding EasyPromos endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    EasyPromos destinations can also be configured manually, allowing you to send data to EasyPromos endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common EasyPromos endpoints. Each template is designed specifically for the corresponding EasyPromos endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

EasyPromos destinations can be manually configured to send data to any valid EasyPromos API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the EasyPromos API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the EasyPromos API from the Method pulldown menu. Common methods for EasyPromos write operations are:

    • POST: For creating new records (participations, coin transactions, autologin)
    • PUT: For replacing existing records (updating coin balances)
    • DELETE: For removing records (removing user segments)

Data Format​

  1. Select the format in which the Nexset data will be sent to the EasyPromos API from the Content Format pulldown menu. EasyPromos expects data in JSON format for all write operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the EasyPromos API endpoint to which you want to send the Nexset data in the URL field. The base URL for the EasyPromos API 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 path.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). For example, some EasyPromos participation endpoints require an X-Requirement header to identify which stage requirement is being satisfied.

    You do not need to include the Authorization header here — it is automatically applied by Nexla using the API Key configured in your EasyPromos credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this EasyPromos destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the EasyPromos API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, confirmation data returned after a participation is submitted or a coin transaction is created.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the EasyPromos API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the EasyPromos API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the EasyPromos API using the current settings.

Save & Activate the Destination​

  • 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 begin sending 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.