Saltar al contenido principal
Referencia de la API

Audiencias y contactos

Audiencias y sus contactos, con importación en lote.

Listar audiencias

GEThttps://api.coffeemail.com.br/v1/product/audiences200

Parámetros de consulta

limitstring
Quantidade máxima de itens retornados
offsetstring
Quantidade de itens a pular

Crear audiencia

POSThttps://api.coffeemail.com.br/v1/product/audiences201

Cuerpo de la solicitud

namestring≥ 1≤ 200obligatorio
Nome da audiência
descriptionstring≤ 1000
Descrição da audiência

Respuesta 201

idstring (uuid)obligatorio
Identificador único da audiência
namestringobligatorio
Nome da audiência
descriptionstringobligatorio
Descrição da audiência
activebooleanobligatorio
Se a audiência está ativa
contactsCountintegermín. 0máx. 9007199254740991obligatorio
Quantidade de contatos na audiência
suppressedCountintegermín. 0máx. 9007199254740991
Contatos da audiência que estão suprimidos ou descadastrados (só no detalhe)
createdAtstring (date-time)obligatorio
Data de criação da audiência
updatedAtstring (date-time)obligatorio
Data da última atualização da audiência

Obtener audiencia

GEThttps://api.coffeemail.com.br/v1/product/audiences/{id}200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Actualizar audiencia

PUThttps://api.coffeemail.com.br/v1/product/audiences/{id}200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Cuerpo de la solicitud

namestring≥ 1≤ 200
Novo nome da audiência
descriptionstring≤ 1000
Nova descrição da audiência
activeboolean
Se a audiência está ativa

Eliminar audiencia

DELETEhttps://api.coffeemail.com.br/v1/product/audiences/{id}200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Listar contactos

GEThttps://api.coffeemail.com.br/v1/product/audiences/{id}/contacts200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Parámetros de consulta

limitstring
Quantidade máxima de itens retornados
offsetstring
Quantidade de itens a pular

Respuesta 200

contactsarray<object>obligatorio
Lista de contatos
totalintegermín. 0máx. 9007199254740991obligatorio
Total de contatos encontrados

Agregar contacto

POSThttps://api.coffeemail.com.br/v1/product/audiences/{id}/contacts201

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Cuerpo de la solicitud

emailstring (email)obligatorio
Endereço de e-mail do contato
firstNamestring≤ 200
Primeiro nome do contato
lastNamestring≤ 200
Sobrenome do contato
metadataobject
Dados extras do contato em formato livre

Respuesta 201

idstring (uuid)obligatorio
Identificador único do contato
emailstringobligatorio
Endereço de e-mail do contato
firstNamestringobligatorio
Primeiro nome do contato
lastNamestringobligatorio
Sobrenome do contato
metadataobjectobligatorio
Dados extras do contato em formato livre
subscribedbooleanobligatorio
Indica se o contato ainda recebe broadcasts (false após descadastro)
source"api" | "csv" | "manual"
Origem do contato: api, csv (importação) ou manual (painel)
status"subscribed" | "unsubscribed" | "suppressed"
subscribed, unsubscribed (descadastrou) ou suppressed (bounce, reclamação etc.)
suppressionReasonstring
Motivo da supressão quando status = suppressed
createdAtstring (date-time)obligatorio
Data de criação do contato

Importar contactos

POSThttps://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/bulk200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência

Cuerpo de la solicitud

contactsarray<object>1+ itensaté 10000 itensobligatorio
Lista de contatos para adicionar em lote
source"api" | "csv" | "manual"
Origem dos contatos; o painel envia csv na importação

Respuesta 200

insertedintegermín. 0máx. 9007199254740991obligatorio
Quantidade de contatos inseridos com sucesso
skippedintegermín. 0máx. 9007199254740991obligatorio
Quantidade de contatos ignorados
createdintegermín. 0máx. 9007199254740991obligatorio
Quantidade de contatos novos criados na organização
existingintegermín. 0máx. 9007199254740991obligatorio
Quantidade de contatos que já existiam na organização e foram atualizados
errorsarray<object>obligatorio
Lista de erros ocorridos durante a inserção em lote

Actualizar contacto

PUThttps://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/{contactId}200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência
contactIdstring≥ 1obligatorio
Identificador do contato

Cuerpo de la solicitud

firstNamestring≤ 200
Novo primeiro nome do contato
lastNamestring≤ 200
Novo sobrenome do contato
metadataobject
Dados extras do contato em formato livre

Eliminar contacto

DELETEhttps://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/{contactId}200

Parámetros de ruta

idstring≥ 1obligatorio
Identificador da audiência
contactIdstring≥ 1obligatorio
Identificador do contato