Recevoir des e-mails : Indicateurs et libellés

Ajouter des libellés

Ajoutez un ou plusieurs libellés à des messages. Les libellés sont créés à la volée et ne sont pas sensibles à la casse.

POSThttps://g.sendcorex.com/v1command: add_labels

Arguments

  • idsstring[]facultatif

    Jusqu'à 100 ids de message.

  • idstringfacultatif

    Un seul id de message. Utilisez-le ou ids.

  • labelsstring[]obligatoire

    Les libellés à ajouter. Chacun fait 50 caractères au maximum.

    ex. : ["urgent", "cliente-vip"]

  • labelstringfacultatif

    Un seul libellé. Utilisez-le ou labels.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "add_labels",
        args: {
          id: "Vj0xQUJDMTIz",
          labels: [
            "urgent",
            "cliente-vip"
          ]
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Réponse

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "add_labels",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "items": [
          {
            "id": "Vj0xQUJDMTIz",
            "ok": true,
            "data": {
              "changed": 1,
              "labels": [
                "urgent",
                "cliente-vip"
              ]
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Champs de la réponse

  • items[].data.changed

    Nombre d'entrées modifiées.

  • items[].data.labels

    Les libellés que le message porte désormais.

  • ok_count / failed_count

    Combien d'ids ont réussi et combien ont échoué.

Trouver les messages libellés

Utilisez list_messages avec label ou search avec field: "label" pour lire tout ce qui porte un libellé.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide.

  • CMDNOT_FOUND

    Le message, la conversation ou le dossier n'existe pas pour ce token.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.