Référence APIÉtiqueter des destinataires
POST/v1/recipients/tag

Étiqueter des destinataires

Ajoute des étiquettes à des destinataires.

1 min de lectureTélécharger en PDF

Requête exemple

{
"add_tags": [
"vip",
"important"
],
"remove_tags": [
"inactive"
],
"recipient_ids": [
"rec_12345abcde",
"rec_67890fghij"
]
}

Réponse exemple

{
"updated": 2,
"tags_added": 4,
"tags_removed": 2
}

Ajoute ou retire des étiquettes sur plusieurs destinataires en une seule opération.

Authentification

Requiert une clé API avec le scope address_book:manage.

Corps de la requête

ChampTypeRequisDescription
recipient_idsarrayOuiIdentifiants des destinataires à modifier.
add_tagsarrayNonÉtiquettes à ajouter.
remove_tagsarrayNonÉtiquettes à retirer.

Codes de statut

  • 200 Étiquettes appliquées.
  • 400 recipient_ids manquant ou aucune action.
  • 403 Scope insuffisant.