Customer Segments Gateway

Instaleap's Ecommerce platform requires a method to retrieve customer segments using search criteria such as the customer's document ID or email. This functionality is needed to update the segments in the following use cases:

  1. When the customer signs up on the Ecommerce platform.
  2. When the customer updates their personal information, including their document ID or email.


For integration simplicity, we suggest using a bearer token to authenticate InstaLeap in your systems

Response Example

  "segments": [
      "type": "affiliation",
      "value": "RECURRENT_CUSTOMER"
      "type": "membership",
      "value": "SILVER"

Success (customer without segments)

  "segments": []

Error Response

  "error": {
    "code": "AN_ERROR_CODE",
    "message": "AN_ERROR_MESSAGE"
Click Try It! to start a request and see the response here!