Referência da API
Audiências e contatos
Audiências e os contatos de cada uma, com importação em lote.
Listar audiências
GET
https://api.coffeemail.com.br/v1/product/audiences200Parâmetros de consulta
limitstring- Quantidade máxima de itens retornados
offsetstring- Quantidade de itens a pular
Criar audiência
POST
https://api.coffeemail.com.br/v1/product/audiences201Corpo da requisição
namestring≥ 1≤ 200obrigatório- Nome da audiência
descriptionstring≤ 1000- Descrição da audiência
Resposta 201
idstring (uuid)obrigatório- Identificador único da audiência
namestringobrigatório- Nome da audiência
descriptionstringobrigatório- Descrição da audiência
activebooleanobrigatório- Se a audiência está ativa
contactsCountintegermín. 0máx. 9007199254740991obrigatório- 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)obrigatório- Data de criação da audiência
updatedAtstring (date-time)obrigatório- Data da última atualização da audiência
Obter audiência
GET
https://api.coffeemail.com.br/v1/product/audiences/{id}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Atualizar audiência
PUT
https://api.coffeemail.com.br/v1/product/audiences/{id}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Corpo da requisição
namestring≥ 1≤ 200- Novo nome da audiência
descriptionstring≤ 1000- Nova descrição da audiência
activeboolean- Se a audiência está ativa
Excluir audiência
DELETE
https://api.coffeemail.com.br/v1/product/audiences/{id}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Listar contatos
GET
https://api.coffeemail.com.br/v1/product/audiences/{id}/contacts200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Parâmetros de consulta
limitstring- Quantidade máxima de itens retornados
offsetstring- Quantidade de itens a pular
Resposta 200
contactsarray<object>obrigatório- Lista de contatos
totalintegermín. 0máx. 9007199254740991obrigatório- Total de contatos encontrados
Adicionar contato
POST
https://api.coffeemail.com.br/v1/product/audiences/{id}/contacts201Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Corpo da requisição
emailstring (email)obrigatório- 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
Resposta 201
idstring (uuid)obrigatório- Identificador único do contato
emailstringobrigatório- Endereço de e-mail do contato
firstNamestringobrigatório- Primeiro nome do contato
lastNamestringobrigatório- Sobrenome do contato
metadataobjectobrigatório- Dados extras do contato em formato livre
subscribedbooleanobrigatório- 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)obrigatório- Data de criação do contato
Importar contatos
POST
https://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/bulk200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
Corpo da requisição
contactsarray<object>1+ itensaté 10000 itensobrigatório- Lista de contatos para adicionar em lote
source"api" | "csv" | "manual"- Origem dos contatos; o painel envia csv na importação
Resposta 200
insertedintegermín. 0máx. 9007199254740991obrigatório- Quantidade de contatos inseridos com sucesso
skippedintegermín. 0máx. 9007199254740991obrigatório- Quantidade de contatos ignorados
createdintegermín. 0máx. 9007199254740991obrigatório- Quantidade de contatos novos criados na organização
existingintegermín. 0máx. 9007199254740991obrigatório- Quantidade de contatos que já existiam na organização e foram atualizados
errorsarray<object>obrigatório- Lista de erros ocorridos durante a inserção em lote
Atualizar contato
PUT
https://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/{contactId}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
contactIdstring≥ 1obrigatório- Identificador do contato
Corpo da requisição
firstNamestring≤ 200- Novo primeiro nome do contato
lastNamestring≤ 200- Novo sobrenome do contato
metadataobject- Dados extras do contato em formato livre
Remover contato
DELETE
https://api.coffeemail.com.br/v1/product/audiences/{id}/contacts/{contactId}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador da audiência
contactIdstring≥ 1obrigatório- Identificador do contato