Criar oportunidade no Salesflare, por uma API

Cria uma oportunidade para uma conta, em uma etapa de um pipeline. account é obrigatório. Retorna a nova oportunidade com seu id.

Identificador
salesflare_create_opportunity

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account": 1
  }
}

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
accountintegerSimId of the account, from List accounts or Create account.
namestringNãoName of the opportunity.
stageintegerNãoId of the stage, from the stages of List pipelines. The stage also sets the pipeline.
valuenumberNãoValue of the deal, in the currency of the pipeline.
probabilitynumberNãoChance of winning, in percent.
close_datestringNãoClose date, in ISO 8601.
main_contactintegerNãoId of the main contact, from List contacts.
ownerintegerNãoId of the user who owns the opportunity, from List users.
assigneeintegerNãoId of the user assigned to the opportunity, from List users.
tagsarrayNãoTag names.
customobjectNãoCustom field values, keyed by the API name of each custom field of the team.

Conexões possíveis

O seu cliente conecta a conta do Salesflare 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/salesflare_create_opportunity. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

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