Listar contatos no Omnisend, por uma API
Lista os contatos com id, email, phone, status, tags, segments e propriedades customizadas, do mais novo para o mais antigo por padrão. A resposta tem contacts e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Identificador
- omnisend_list_contacts
A chamada
POST https://connect.reportei.com/api/tools/omnisend_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| string | Não | Only the contact with this email address. | |
| phone | string | Não | Only the contact with this phone number, in E.164 format such as +5511999998888. |
| status | string | Não | Only the contacts with this email subscription status. Does not work together with tag.Valores: subscribed, unsubscribed, nonSubscribed |
| tag | string | Não | Only the contacts with this tag. Does not work together with status. |
| segmentID | string | Não | Only the contacts of this segment, by the segmentID from List segments. |
| updatedAtFrom | string | Não | Only the contacts updated at or after this RFC 3339 date-time. Does not work together with the other filters. |
| sort | string | Não | Field to sort by. The default is createdAt.Valores: createdAt, updatedAt |
| direction | string | Não | Order of the sort, used only with sort. The default is desc.Valores: asc, desc |
| limit | integer | Não | Contacts per page, up to 250. The default is 100. |
| after | string | Não | The paging.cursors.after of the previous page. |
Conexões possíveis
O seu cliente conecta a conta do Omnisend uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/omnisend_list_contacts. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Omnisend
- Criar contatoPOSTCria um contato, ou atualiza o contato que já tem o mesmo identificador de email. Definir um canal como subscribed envia a mensagem de boas-vindas da marca, quando essa automação está ativa, a menos que sendWelcomeMessage seja false.
- Atualizar contatoPATCHAtualiza um contato. Só os campos enviados mudam, mas tags substitui a lista inteira de tags: para só adicionar tags, use Aplicar tags. Um status de canal em identifiers inscreve ou cancela a inscrição do contato.
- Aplicar tagsPOSTAdiciona tags a contatos, mantendo as tags que eles já têm. Escolha os contatos por contactIDs, emails, phones ou segmentID; as seleções se somam. Limitado a 60 chamadas por minuto.
- Listar segmentosGETLista os segmentos com segmentID, name e status. O segmentID direciona campanhas e filtra contatos. A resposta tem segments e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar templates de emailGETLista os templates de email com id e name, do mais novo para o mais antigo por padrão. O id é o corpo de uma campanha de email. A resposta tem templates e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar campanhasGETLista as campanhas com id, name, status, channel, content, audience e configurações de envio, da mais nova para a mais antiga por padrão. A resposta tem campaigns e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Criar campanhaPOSTCria uma campanha comum de email ou SMS como rascunho e a retorna com seu id. Uma campanha de email precisa de content.email.templateID, de Listar templates de email, e uma de SMS precisa de content.sms. Nada é enviado até Enviar campanha.
- Atualizar campanhaPATCHAtualiza uma campanha em status draft. Só os campos enviados mudam. O template de email continua o definido na criação. Para alterar uma campanha que não é mais rascunho, o app pede uma cópia.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
