Criar campanha no Omnisend, por uma API

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

Identificador
omnisend_create_campaign

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "regular",
    "channel": "email",
    "name": "<name>",
    "content": {}
  }
}

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
typestringSimAlways regular.Valores: regular
channelstringSimChannel of the campaign.Valores: email, sms
namestringSimInternal name of the campaign.
languagestringNãoLanguage of the campaign as xx_XX, for example pt_BR. The default is en_US.
contentobjectSimContent of the campaign: email for an email campaign or sms for an SMS campaign.
audienceobjectNãoWho receives the campaign. Without includedSegmentIDs, every subscriber of the channel receives it. Included and excluded segments must not overlap.
sendingSettingsobjectNãoWhen Send campaign sends it. The default strategy is immediate.

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