Arianee Protocol Documentation

Auto Message Campaign

Communicate with your audience through auto message campaigns.

Suggest Edits

Before you begin

Create an auto-message campaign to communicate by targeting your audience every time rules are triggered.

Use case example: Your brand has sold a product to a customer. You welcome this user and tell what this product passport gives access to. As the messages are not accessible for a new owner, you want this message to be sent to each new owner after a transfer.

β›”

Limitations

  • NFT owners cannot reply to your auto message campaigns.
  • Tags and transfers are the only primitives to target our owners audience and send campaigns.

Let's start πŸš€

Create Auto Message Campaign

Step 1: Create your auto message campaign draft respecting the Message Schema by using the /autoMessage.

πŸ“Œ

The API is authenticated with the user rights required β†’ certCreate

{
    "campaignName": "Welcome to your Arianee NFT!",
    "tagRule": "or",
    "uniqueOwner": true,
    "tags": ["dropJan23","dropFeb23"],
  	"content": "{\"$schema\":\"https://cert.arianee.org/version1/ArianeeMessage-i18n.json\",\"language\":\"en-US\",\"i18n\":[{\"language\":\"en-US\",\"title\":\"Hello you !\",\"content\":\"My message content here.\"}]}",
    "status": "DRAFT"
}
InputMandatoryTypeDescription
campaignNameβœ…StringName of the campaign. The first thing displayed in the customers' wallet.
tagRuleβœ…StringTag 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.
uniqueOwnerβœ…Booleantrue: One message is sent per wallet even if your customer owns several digital passports.
tags❌StringUse tags to target your web3 audience.
⚠️ Tags are case-sensitive.
content❌ObjectFor more information on the content $schema, see Message Schema.
statutβœ…StringStatut set as DRAFT.

Result: Your auto-message campaign draft has been created and is ready to be triggered. Keep the _id, ID of the campaign in case you wish to update the content afterward.

{
    "tags": [
        "tag_test",
        "other_tag"
    ],
    "_id": "63ee4e3822c4554801f712a8",
    "campaignName": "Campaign name",
    "tagRule": "or",
    "content": "{\"$schema\":\"https://cert.arianee.org/version1/ArianeeMessage-i18n.json\",\"language\":\"en-US\",\"i18n\":[{\"language\":\"en-US\",\"title\":\"Hello you !\",\"content\":\"My message content here.\"}]}",
    "createdAt": "2023-02-16T15:39:36.389Z",
    "updatedAt": "2023-02-16T15:39:36.389Z",
    "__v": 0,
    "id": "63ee4e3822c4554801f712a8"
}

Update Auto Message Campaign

Update the content of your auto message campaign, e.g. let's say you wish to correct your campaign title and use the /autoMessage/{{_Iid}}.

{
    "campaignName": "Welcome to your Arianee NFT!",
    "tagRule": "or",
    "uniqueOwner": true,
    "tags": ["dropJan23","dropFeb23"],
  	"content": "{\"$schema\":\"https://cert.arianee.org/version1/ArianeeMessage-i18n.json\",\"language\":\"en-US\",\"i18n\":[{\"language\":\"en-US\",\"title\":\"Hello you !\",\"content\":\"My message content here.\"}]}",
    "status": "DRAFT"
}

Result: Your campaign has been updated.

httpCodeDescription
200Your auto-message campaign has been updated.
400Your auto-off-message campaign ID may not exist.
{
    "tags": [
        "tag_test",
        "other_tag"
    ],
    "_id": "63ee4e3822c4554801f712a8",
    "campaignName": "Welcome to your Arianee NFT!!",
    "tagRule": "or",
    "content": "{\"$schema\":\"https://cert.arianee.org/version1/ArianeeMessage-i18n.json\",\"language\":\"en-US\",\"i18n\":[{\"language\":\"en-US\",\"title\":\"Hello you !\",\"content\":\"My message content here.\"}]}",
    "createdAt": "2023-02-16T15:39:36.389Z",
    "updatedAt": "2023-03-16T14:42:19.100Z",
    "__v": 0,
    "enable": false,
    "id": "63ee4e3822c4554801f712a8"
}

{
    "stringValue": "\"63ee4e3822c4554801f7\"",
    "kind": "ObjectId",
    "value": "63ee4e3822c4554801f7",
    "path": "_id",
    "reason": {}
}

Updated 6 months ago