Pular para o conteúdo
Funil

Criar negócio

v1.0.0
POSThttps://api.growthaisystem.com/api/v1/opportunities
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposopportunities.write

stageId ausente = primeiro estágio aberto do funil. Aceita Idempotency-Key. source é o canal DESTA entrada (ex.: youtube, lp, trafego) e utmSource/utmMedium/utmCampaign/utmTerm/utmContent as UTMs DESTA entrada — gravados no negócio, nunca herdados do contato. source ausente cai em utmSource; nenhum dos dois = source: null.

Corpo da requisição

application/jsonobrigatório
  • contactIdstringobrigatório
    • tamanho mín. 1
  • pipelineIdstringobrigatório
    • tamanho mín. 1
  • stageIdstring | nullopcional
  • titlestringobrigatório
    • tamanho 1–200
  • valueCentsintegeropcional
    • faixa 0–1000000000
  • expectedCloseAtstring | nullopcional
  • ownerUserIdstring | nullopcional
  • customFieldsobjeto livreopcional
    • chave string
    • valor qualquer valor JSON
  • sourcestring | nullopcional
    • tamanho máx. 120
  • utmSourcestring | nullopcional
    • tamanho máx. 255
  • utmMediumstring | nullopcional
    • tamanho máx. 255
  • utmCampaignstring | nullopcional
    • tamanho máx. 255
  • utmTermstring | nullopcional
    • tamanho máx. 255
  • utmContentstring | nullopcional
    • tamanho máx. 255

Respostas

12 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A Idempotency-Key repetiu uma criação anterior: devolve o MESMO negócio, com idempotency_replay: true. Nada novo foi criado.

V1OpportunityEscrita

  • idstring
  • titlestring
  • pipelineIdstring
  • stageIdstring
  • contactIdstring
  • statusstring
    • um de"open""won""lost""abandoned"
  • valueCentsinteger
  • currencystring
  • ownerUserIdstring | null
  • temperaturestring
  • tagsstring[]
  • lossReasonstring | null
  • expectedCloseAtstring | null
  • wonAtstring | null
  • wonRecordedAtstring | null
  • lostAtstring | null
  • lostRecordedAtstring | null
  • lostAtStageIdstring | null
  • customFieldsobjeto livre
    • chave string
    • valor qualquer valor JSON
  • createdAtstring
  • updatedAtstring
  • sourcestring | null
    • sourcestring | null
    • mediumstring | null
    • campaignstring | null
    • termstring | null
    • contentstring | null
  • originstring
  • stageChangedAtstring
  • urlstring
  • firstHumanTouchAtstring | nullpode faltar
  • lastHumanTouchAtstring | nullpode faltar
  • humanTouchCountintegerpode faltar

    Quantos toques humanos o contato deste negócio recebeu desde a CRIAÇÃO do negócio (cada mensagem, ligação, e-mail ou nota com actor: "user" em /interactions conta um). 0 = nenhum. Mesma fonte e mesmo recorte de firstHumanTouchAt/lastHumanTouchAt. Vem em GET /opportunities e em GET /opportunities/{id}.

    • mín. 0
  • firstHumanTouchChannelstring | nullpode faltar

    O canal do PRIMEIRO toque humano desde a criação do negócio — o mesmo registro de firstHumanTouchAt, no vocabulário de channel de /interactions (whatsapp, instagram, facebook, call, email, note…). Dois toques no mesmo instante: vale o de menor id de /interactions. null = ainda não houve toque humano.

  • lastActivityAtstring | nullpode faltar
  • idempotency_replaybooleanpode faltar

    Só presente (e sempre true) quando a Idempotency-Key repetiu uma escrita anterior.