Contatos: tags, status e campos

Adicionar tags

Adicione uma ou mais tags a até 500 contatos. As tags são criadas na hora e ignoram maiúsculas e acentos.

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

Precisa do scope contact:update na sua API key.

Argumentos

  • emailsstring[]opcional

    Até 500 emails. Maiúsculas e espaços nas pontas são ignorados, e emails repetidos contam uma vez.

  • emailstringopcional

    Um único email. Use este ou emails.

  • tagsstring[]obrigatório

    As tags a adicionar. "Black Friday" e "black friday" são a mesma tag.

    ex.: ["black-friday"]

  • return_contactsbooleanopcional

    Adiciona o contato inteiro após a alteração a cada item.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "add_tags",
        args: {
          emails: [
            "ana@acme.com",
            "bob@gmail.com"
          ],
          tags: [
            "black-friday"
          ]
        }
      }
    ]
  },
  { 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);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "add_tags",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "changed": true
            }
          },
          {
            "id": "bob@gmail.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 2,
        "failed_count": 0
      }
    }
  ]
}

Campos da resposta

  • items[].id

    O email que você enviou, como você enviou.

  • items[].ok

    true quando este email funcionou. Quando false, o item tem code e message.

  • items[].data.changed

    false significa que o contato já estava assim, então nada foi gravado.

  • items[].data.contact

    O contato inteiro após a alteração. Só com return_contacts: true.

  • ok_count / failed_count

    Quantos emails funcionaram e quantos falharam.

Marque todos que uma consulta encontrar

Combine com Query Contacts e $ref para marcar um segmento inteiro em um único request, sem passar os emails pela sua aplicação.

Corpo do request

{
  "commands": [
    {
      "command": "query_contacts",
      "id": "q",
      "args": {
        "where": {
          "last_open_at": {
            "within_days": 7
          }
        },
        "select": [
          "email"
        ],
        "limit": 500
      }
    },
    {
      "command": "add_tags",
      "args": {
        "emails": {
          "$ref": "q",
          "path": "contacts/*/email"
        },
        "tags": [
          "active-this-week"
        ]
      }
    }
  ]
}
i

Um contato tem até 50 tags. A contagem de tags por conta está em Get Stats.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDNOT_FOUND

    O contato, a lista, o campo ou o segmento não existe.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.