Atualizar contato no Omnisend, por uma API

Atualiza 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.

Identificador
omnisend_update_contact

A chamada

POST https://connect.reportei.com/api/tools/omnisend_update_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>"
  }
}

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âmetroTipoObrigatórioDescrição
idstringSimID of the contact, from List contacts.
identifiersarrayNãoEmail and phone of the contact, each with the subscription status of its channel: email for the email identifier and sms for the phone identifier.
firstNamestringNãoFirst name of the contact.
lastNamestringNãoLast name of the contact.
tagsarrayNãoThe full list of tags the contact keeps. An empty list removes every tag.
customPropertiesobjectNãoCustom properties to change, keyed by name, with Latin letters, digits and underscores only. An empty value removes the property.
genderstringNãoGender of the contact.Valores: m, f
birthdatestringNãoBirth date of the contact, as YYYY-MM-DD.
addressstringNãoStreet, number and apartment.
citystringNãoCity.
statestringNãoState as the ISO 3166-2 subdivision code, for example SP.
postalCodestringNãoPostal code.
countryCodestringNãoCountry as the ISO 3166-1 alpha-2 code, for example BR.

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_update_contact. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Omnisend

Ver as 14 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.