Contacts : champs personnalisés

Supprimer un champ

Supprimez un champ personnalisé. Il disparaît immédiatement, et ses valeurs sont retirées de tous les contacts en arrière-plan.

POSThttps://g.sendcorex.com/v1/contactscommand: delete_field
i

Nécessite le scope contact:delete sur votre API key.

!

Les valeurs sont irrécupérables. Les segments et requêtes qui utilisent le champ échouent immédiatement avec INVALID_ARGS.

Arguments

  • keystringobligatoire

    Le champ à supprimer.

    ex. : "vip"

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "delete_field",
        args: {
          key: "vip"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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_field",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "deleted": true,
        "purging": true
      }
    }
  ]
}

Champs de la réponse

  • deleted

    true. Le champ n'apparaît plus dans List Fields.

  • purging

    true pendant que les valeurs sont retirées des contacts.

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.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…

  • CMDNOT_FOUND

    Le contact, la liste, le champ ou le segment n'existe pas.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.