Contacts : contacts

Mettre à jour des contacts

Modifiez des contacts existants, jusqu'à 500 par commande. Mêmes arguments qu'Upsert Contacts, mais ne crée jamais : un email qui n'est pas un contact échoue avec NOT_FOUND.

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

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

i

Utilisez-le quand votre application ne doit toucher que des personnes déjà contacts, par exemple un formulaire de profil qui ne doit pas ajouter d'inconnus.

Arguments

  • contactsobject[]obligatoire

    De 1 à 500 lignes avec un email et les parties à modifier. Mêmes champs qu'Upsert Contacts.

  • list_idstringfacultatif

    Ajoute aussi tous les contacts de cette commande à cette liste.

  • tagsstring[]facultatif

    Tags ajoutés à tous les contacts de cette commande.

  • return_contactsbooleanfacultatif

    Ajoute à chaque élément le contact complet après la modification.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "update_contacts",
        args: {
          contacts: [
            {
              email: "ana@acme.com",
              last_name: "Costa",
              fields: {
                plan: "business"
              }
            }
          ]
        }
      }
    ]
  },
  { 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": "update_contacts",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "created": false,
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0,
        "created": 0,
        "updated": 1,
        "unchanged": 0
      }
    }
  ]
}

Champs de la réponse

  • items[].data.changed

    false quand le contact avait déjà ces valeurs.

  • updated / unchanged

    Combien de contacts ont changé et combien étaient déjà à jour. created vaut toujours 0.

  • ok_count / failed_count

    Combien de lignes ont réussi et combien ont échoué.

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.