Create Audience

To target a specific audience for campaigns, fetch the relevant users using parameters and filters.

Why segment your audience?

Arianee builds a new way for brands to connect with customers.

Segmenting the audience is essential for effective communication because it allows tailored campaigns to be crafted to suit the specific needs, preferences, and characteristics of each segment.

Use cases

  • Your brand distributes product passports according to the product model. Each digital passport of a model is associated with a tag. You want to send a campaign to the owners of a particular model.
  • Your brand distributed digital passports in an account that is not tied to the client account (non-custodial), you want to reach out to this audience.

What segmentation?

To target your audience for a new once-off message campaign, you need to segment the recipients of your campaigns. You can decide to target your audience using:

  • tags: pre-defined tags associated with a pool of digital passports.
  • custodialWallet: target custodial or non-custodial wallets.
  • isWalletActiveSinceNumberOfDays: define the number of days the user has been active on his wallet lately.
  • countries: target countries.
💡

All filter types can be combined to refine your target audience.

Let's start 🚀

URL

Required rights: admin, messageSend, or eventCreate

To create a new audience segment, use /audience/create.

POST - https://{{nmpUrl}}/audience/create

Body

Field

Type

Required

Description

name

String

Name of the audience for your campaign.

tagRule

Object

Tag rules that define if your audience must own all mentioned tags or at least one.
or: The owner must have a digital passport with at least one defined tag.
and: The owner must have a digital passport that includes all specified tags.

tags

Array

Tag(s) associated with the digital passports you wish to target.

uniqueOwner

Boolean

true: One message is sent per wallet even if your customer owns several digital passports.

custodialWallet

String

Custodial or non-custodial wallet.
yes: Send to custodial wallet only.
no: Send to non-custodial wallet only.
all: Both types of wallet.

isWalletActiveSinceNumberOfDays

Number

A period in days during which activity was observed on the user's wallet.

countries

Array

Define the target country.
String with values separated by a pipe
Example: France|Spain...
⚠️ Countries are case-sensitive.

{
    "name": "Audience test",
    "tagRule": "all",
    "tags": "test",
    "uniqueOwner": false,
    "custodialWallet": "yes", 
    "isWalletActiveSinceNumberOfDays": 30,
    "countries": [
        "France",
        "Spain"
    ]
}

Return Payload

Status CodeSuccessDescription
200trueThe audience segment has been created.
{
    "name": "audience test 123",
    "tagRule": "all",
    "uniqueOwner": false,
    "_id": "660ffa248b242638ac6ccac5",
    "createdAt": "2024-04-05T13:18:28.777Z",
    "updatedAt": "2024-04-05T13:18:28.777Z",
    "__v": 0
}