Create an audience. The audience can be created directly from scratch or can come from third party platforms.

Note: Audiences can also be created from scratch via the Campaign Manager. See the docs.

To create an audience from an existing audience from a technology partner:

1. Set the integration property to mparticle, segment etc., depending on a third-party platform.
2. Set integrationId to the ID of this audience in a third-party platform.

To create an audience from an existing audience in another platform:

1. Do not use the integration property.
2. Set integrationId to the ID of this audience in the 3rd-party platform.

To create an audience from scratch:

1. Only set the name property.

Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.

Delete an audience created by a third-party integration.

Warning: This endpoint also removes any associations recorded between a customer profile and this audience.

Note: Audiences can also be deleted via the Campaign Manager. See the docs.

Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does not trigger the rule engine.

To update the audience's members, use the Update customer profile endpoint.

Remove all members from this audience.

Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences.

The limit of customer profiles per request is 1000.

Update the specified profile attributes to the provided values for all customers in the specified audience.

Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions:

• Add an item to the catalog.
• Edit the attributes of an item in the catalog.
• Edit the attributes of more than one item in the catalog.
• Remove an item from the catalog.
• Remove more than one item from the catalog.

Note: For more information, see our documentation on managing cart item catalogs.

Filtering cart items

Use cart item attributes to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time.

The filters array contains an object with the following properties:

• attr: A cart item attribute connected to the catalog. It is applied to all items in the catalog.

• op: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the value property for the attribute selected in attr.

  The value of op can be one of the following:

  • EQ: Equal to value
  • LT: Less than value
  • LE: Less than or equal to value
  • GT: Greater than value
  • GE: Greater than or equal to value
  • IN: One of the comma-separated values that value is set to.

  Note: GE, LE, GT, LT are for numeric values only.

• value: The value of the attribute selected in attr.

Payload examples

Synchronization actions are sent as PUT requests. See the structure for each action:

{
  "actions": [
    {
      "payload": {
        "attributes": {
          "color": "Navy blue",
          "type": "shoe"
        },
        "replaceIfExists": true,
        "sku": "SKU1241028",
        "price": 100
      },
      "type": "ADD"
    }
  ]
}

{
  "actions": [
    {
      "payload": {
        "attributes": {
          "age": 11,
          "origin": "germany"
        },
        "createIfNotExists": false,
        "sku": "SKU1241028"
      },
      "type": "PATCH"
    }
  ]
}

{
  "actions": [
    {
      "payload": {
        "attributes": {
          "color": "red"
        },
        "filters": [
          {
            "attr": "color",
            "op": "EQ",
            "value": "blue"
          }
        ]
      },
      "type": "PATCH_MANY"
    }
  ]
}

{
  "actions": [
    {
      "payload": {
        "sku": "SKU1241028"
      },
      "type": "REMOVE"
    }
  ]
}

{
  "actions": [
    {
      "payload": {
        "filters": [
          {
            "attr": "color",
            "op": "EQ",
            "value": "blue"
          }
        ]
      },
      "type": "REMOVE_MANY"
    }
  ]
}

{
  "actions": [
    {
      "payload": {
        "filters": [
          {
            "attr": "size",
            "op": "GT",
            "value": "45"
          }
        ]
      },
      "type": "REMOVE_MANY"
    }
  ]
}

Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the Create coupon code reservation effect.

Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the List customer data endpoint.

If a coupon gets created for a specific user, it will automatically appear in their coupons.

When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the List customer data endpoint.

For example, you can use this endpoint and List customer data to create a coupon wallet by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store.

To delete a reservation, use the Delete reservation endpoint.

Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.

Return all customers that have this coupon marked as reserved.

Coupons are reserved in the following ways:

• To create a soft reservation (any customer can use the coupon), use the Create coupon reservation endpoint.
• To create a hard reservation (only the given customer can use the coupon), create a coupon in the Campaign Manager for a given recipientIntegrationId or use the Create coupons or Create coupons for multiple recipients endpoints.

Update or create a Customer Profile. This endpoint triggers the Rule Builder.

You can use this endpoint to:

• Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first.
• Modify the audience the customer profile is a member of.

Update (or create) up to 1000 customer profiles in 1 request.

The integrationId must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.

A customer profile can be linked to one or more sessions.

Delete all attributes on the customer profile and on entities that reference this customer profile.

Important: To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.

Return the customer inventory regarding entities referencing this customer profile's integrationId.

Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.

Update or create a customer session. The endpoint responds with the potential promotion rule effects that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One.

Note: The currency for the session and the cart items in the session is the currency set for the Application that owns this session.

Session management

To use this endpoint, start by learning about customer sessions and their states and refer to the state parameter documentation the request body schema docs below.

Sessions and customer profiles

• To link a session to a customer profile, set the profileId parameter in the request body to a customer profile's integrationId.
• While you can create an anonymous session with profileId="", we recommend you use a guest ID instead.
• A profile can be linked to simultaneous sessions in different Applications. Either:
  • Use unique session integration IDs or,
  • Use the same session integration ID across all of the Applications.

Note: If the specified profile does not exist, an empty profile is created automatically. You can update it with Update customer profile.

For more information, see:

• The introductory video in Getting started.
• The integration tutorial.