Envoyer des messages de campagne via une distribution déclenchée par API

Utilisez cet endpoint pour envoyer des messages immédiats et ponctuels à des utilisateurs désignés via une distribution déclenchée par API.

La distribution déclenchée par API vous permet d’héberger le contenu des messages dans le tableau de bord de Braze tout en contrôlant, via votre API, quand un message est envoyé et à qui.

Si vous ciblez un segment, un enregistrement de votre requête est conservé dans la console de développement. Pour envoyer des messages avec cet endpoint, vous devez disposer d’un ID de campagne créé lors de la création d’une Campaign déclenchée par API.

Conditions préalables

Pour utiliser cet endpoint, vous devez générer une clé API avec l’autorisation campaigns.trigger.send.

Limite de débit

Lorsque vous utilisez des filtres Connected Audience dans votre requête, nous appliquons une limite de débit de 250 requêtes par minute à cet endpoint. Sinon, si vous spécifiez un external_id, cet endpoint présente une limite de débit par défaut de 250 000 requêtes par heure, partagée entre les endpoints documentés dans Limites de débit de l’API.

Les endpoints Braze prennent en charge le traitement par lots des requêtes API. Une seule requête aux endpoints d’envoi de messages peut atteindre n’importe lequel des éléments suivants :

• Jusqu’à 50 external_ids spécifiques, chacun avec des paramètres de message individuels
• Un segment d’audience de toute taille, défini dans la requête comme un objet Connected Audience

Les endpoints Braze prennent en charge le traitement par lots des requêtes API. Une seule requête aux endpoints d’envoi de messages peut atteindre n’importe lequel des éléments suivants :

• Jusqu’à 50 external_ids spécifiques, chacun avec des paramètres de message individuels
• Un segment d’audience de toute taille, défini dans la requête comme un objet Connected Audience

Corps de la requête

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "campaign_id": (required, string) see campaign identifier,
  "send_id": (optional, string) see send identifier,
  "trigger_properties": (optional, object) personalization key-value pairs that apply to all users in this request,
  "broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if "recipients" is omitted,
  "audience": (optional, connected audience object) see connected audience,
  // Including 'audience' sends to only users in the audience
  "recipients": (optional, array; if not provided and broadcast is not set to `false`, message sends to the entire segment targeted by the campaign)
    [
      {
      // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one.
      "user_alias": (optional, user alias object) user alias of user to receive message,
      "external_user_id": (optional, string) external identifier of user to receive message,
      "email": (optional, string) email address of user to receive message,
      "prioritization": (optional, array) prioritization array; required when using email,
      "trigger_properties": (optional, object) personalization key-value pairs that apply to this user (these key-value pairs override any keys that conflict with the parent trigger_properties),
      "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases; if set to `false`, an attributes object must also be included,
      "attributes": (optional, object) fields in the attributes object create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values are overwritten
    }
  ],
  "attachments": (optional, array) array of JSON objects that define the files you need attached, defined by "file_name" and "url",
    [
      {
       "file_name": (required, string) the name of the file you want to attach to your email, excluding the extension (for example, ".pdf"). Attach files up to 2 MB. This is required if you use "attachments",
       "url": (required, string) the corresponding URL of the file you want to attach to your email. The file name's extension is detected automatically from the URL defined, which should return the appropriate "Content-Type" as a response header. This is required if you use "attachments",
      }
    ]
}

Paramètres de la requête

Comportement de résolution des destinataires

Cette section explique comment Braze sélectionne un profil utilisateur pour l’envoi et ce qui se passe lorsqu’aucun profil n’est sélectionné.

Le statut du groupe d’abonnement d’un utilisateur peut être mis à jour en incluant un paramètre subscription_groups dans l’objet attributes. Pour plus de détails, consultez Objet attributs utilisateur.

Limites de destinataires et création de profils

Découvrez comment les limites de destinataires et la création de profils fonctionnent pour cet endpoint.

• Le tableau recipients peut contenir jusqu’à 50 objets, chacun contenant une seule chaîne external_user_id et un objet trigger_properties.
• Lorsque send_to_existing_only est true (valeur par défaut), Braze envoie le message uniquement aux utilisateurs existants.
• Lorsque send_to_existing_only est false et qu’un objet attributes est fourni, Braze crée un nouvel utilisateur s’il n’en existe pas.
• Les nouveaux profils nécessitent attributes avec send_to_existing_only: false. Braze exécute la création ou la mise à jour pré-envoi à partir de l’objet attributes dans le même destinataire. Si vous définissez send_to_existing_only sur false mais omettez attributes (ou envoyez un objet vide), Braze n’hydrate pas les données du profil de la même manière, et vous n’obtenez donc pas le comportement combiné « créer ou mettre à jour l’utilisateur, puis envoyer » pour lequel ce modèle est conçu.
• Adressage e-mail et SMS. Pour la plupart des envois par e-mail ou SMS déclenchés par API à une personne qui n’est pas encore dans Braze, incluez les champs de distribution nécessaires dans attributes (par exemple email, ou les attributs téléphoniques utilisés par votre espace de travail pour le SMS). Vous pouvez également y définir l’appartenance à un groupe d’abonnement ou le statut d’abonnement lorsque l’état d’abonnement doit être modifié dans le même appel.
• Éligibilité à la Campaign. Une fois le profil créé ou mis à jour, cet utilisateur doit toujours correspondre à l’audience cible de la Campaign dans le tableau de bord et aux règles d’envoi du canal (par exemple, être abonné aux e-mails), sinon Braze n’envoie pas le message.
• Définir send_to_existing_only sur false n’est pas pris en charge pour les alias d’utilisateur. Les nouveaux utilisateurs disposant uniquement d’un alias ne peuvent pas être créés via cet endpoint. Pour envoyer un message à un utilisateur disposant uniquement d’un alias, celui-ci doit déjà exister dans Braze.

Identifiant e-mail et résolution des égalités de priorisation

Lorsque vous identifiez les destinataires par e-mail, Braze utilise prioritization. Braze envoie uniquement lorsque prioritization renvoie un seul profil.

• Si vous utilisez email comme identifiant, Braze résout le destinataire à l’aide de prioritization.
• Si prioritization renvoie une égalité, Braze n’envoie pas.
• Braze envoie une fois l’égalité résolue et lorsque prioritization renvoie un seul profil. Par exemple, si des mises à jour de profil modifient les champs de classement d’un utilisateur, Braze envoie dès que prioritization peut identifier un profil de manière unique (voir Comportement de nouvelle tentative et send_to_existing_only).
• Braze n’envoie pas non plus lorsque prioritization ne renvoie aucun profil.

Comportement de nouvelle tentative et send_to_existing_only

Découvrez ce qui se passe lorsque prioritization ne renvoie pas exactement un seul profil.

• Lorsque prioritization ne renvoie pas exactement un seul profil utilisateur, Braze retente la résolution jusqu’à 40 fois. Ce comportement de nouvelle tentative est attendu.
• Le paramètre send_to_existing_only ne modifie pas le comportement en cas d’égalité de prioritization. Le même comportement d’égalité et de nouvelle tentative s’applique, que ce paramètre soit défini sur true ou false.

Remarque

Le paramètre segment_id n’est pas pris en charge pour cet endpoint. Pour cibler un segment, configurez-le dans les paramètres d’audience cible de la Campaign dans le tableau de bord de Braze et utilisez "broadcast": true, ou utilisez le paramètre audience avec les filtres Connected Audience.

Exemple de requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "send_id": "send_identifier",
  "trigger_properties": "",
  "broadcast": false,
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "eye_color",
          "comparison": "equals",
          "value": "blue"
        }
      },
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_foods",
          "comparison": "includes_value",
          "value": "pizza"
        }
      },
      {
        "OR": [
          {
            "custom_attribute": {
              "custom_attribute_name": "last_purchase_time",
              "comparison": "less_than_x_days_ago",
              "value": 2
            }
          },
          {
            "push_subscription_status": {
              "comparison": "is",
              "value": "opted_in"
            }
          }
        ]
      },
      {
        "email_subscription_status": {
          "comparison": "is_not",
          "value": "subscribed"
        }
      },
      {
        "last_used_app": {
          "comparison": "after",
          "value": "2019-07-22T13:17:55+0000"
        }
      }
    ]
  },
  "recipients": [
    {
      "user_alias": {
        "alias_name" : "example_name",
        "alias_label" : "example_label"
      },
      "external_user_id": "external_user_identifier",
      "trigger_properties": "",
      "send_to_existing_only": true,
      "attributes": {
        "first_name" : "Alex"
      }
    }
  ],
  "attachments": [
    {
      "file_name" : "YourFileName",
      "url" : "https://exampleurl.com/YourFileName.pdf"
    }
  ]
}'

Détails de la réponse

Les réponses des endpoints d’envoi de messages incluent le dispatch_id du message, qui sert de référence pour le suivi de l’envoi. Le dispatch_id est l’identifiant de l’envoi, un ID unique pour chaque transmission effectuée depuis Braze. Lorsque vous utilisez cet endpoint, vous recevez un seul dispatch_id pour l’ensemble du lot d’utilisateurs. Pour en savoir plus sur le dispatch_id, consultez notre documentation sur le comportement du Dispatch ID.

Si votre requête rencontre une erreur fatale, consultez la section Erreurs et réponses pour connaître le code d’erreur et sa description.

Objet attributs pour les Campaigns

Braze dispose d’un objet de messagerie appelé attributes qui vous permet d’ajouter, de créer ou de mettre à jour les attributs et les valeurs d’un utilisateur avant de lui envoyer une Campaign déclenchée par API. L’utilisation de l’endpoint campaign/trigger/send permet de traiter l’objet des attributs utilisateur avant de traiter et d’envoyer la Campaign. Cela permet de minimiser le risque de problèmes causés par des conditions de concurrence.

Conseil

Vous recherchez la version Canvas de cet endpoint ? Consultez Envoyer des messages Canvas via une distribution déclenchée par API.