Contactos: contactos
Actualizar contactos
Modifica contactos existentes, hasta 500 por comando. Mismos argumentos que Upsert Contacts, pero nunca crea: un email que no es contacto falla con NOT_FOUND.
https://g.sendcorex.com/v1/contactscommand: update_contactsNecesita el scope contact:update en tu API key.
Úsalo cuando tu aplicación solo deba tocar a personas que ya son contactos, por ejemplo un formulario de perfil que no debe añadir desconocidos.
Argumentos
contactsobject[]obligatorioDe 1 a 500 filas con un
emaily las partes a cambiar. Mismos campos que Upsert Contacts.list_idstringopcionalTambién añade todos los contactos de este comando a esta lista.
tagsstring[]opcionalEtiquetas añadidas a todos los contactos de este comando.
return_contactsbooleanopcionalAñade a cada elemento el contacto completo después del cambio.
Inicio rápido
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);Respuesta
{
"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
}
}
]
}Campos de la respuesta
items[].data.changedfalsecuando el contacto ya tenía esos valores.updated / unchangedCuántos contactos cambiaron y cuántos ya estaban al día.
createdsiempre es0.ok_count / failed_countCuántas filas funcionaron y cuántas fallaron.
Errores
Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.
- 401
INVALID_API_KEYLa API key no existe, se revocó o se desactivó en el dashboard.
- 429
RATE_LIMITEDMás de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.
- CMD
MISSING_SCOPELa API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.
- CMD
INVALID_ARGSFalta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…
- CMD
NOT_FOUNDEl contacto, la lista, el campo o el segmento no existe.
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.