Recevoir des emails : Contacts et audience

Supprimer un segment

Supprime un segment de cette boîte.

POSThttps://g.sendcorex.com/v1command: delete_segment
i

Nécessite la permission d’organiser (pas pour les jetons en lecture seule).

Arguments

  • segment_idstringobligatoire

    L’id du segment.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "delete_segment",
        args: {
          segment_id: "seg_8Hq2"
        }
      }
    ]
  },
  { 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": "delete_segment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "deleted": true
      }
    }
  ]
}

Champs de la réponse

  • deleted

    true quand il a été supprimé.

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.

  • CMDNOT_FOUND

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

  • CMDREAD_ONLY_ACCESS

    Le token ou l’application a un accès en Lecture seule et la commande écrit. Sur la route d’envoi de pièce jointe, c’est HTTP 403.

  • CMDINTERNAL

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