Pular para o conteúdo
Funil

Atualizar negócio

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

Só os campos enviados mudam. wonAt/lostAt (AAAA-MM-DD, no fuso da conta) corrigem a data real de um negócio JÁ ganho/perdido e pedem changeReason: a data não pode ser futura (anterior à criação do negócio vale, o caso da migração de outro CRM), e a alteração entra na trilha de datas do negócio com a origem api (antes → depois, motivo). Para tirar a data, reabra o negócio (POST /opportunities/{id}/reopen). Corrigir só a data não dispara de novo as automações de ganho ou perda.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Corpo da requisição

application/jsonobrigatório
  • titlestringopcional
    • tamanho 1–200
  • valueCentsintegeropcional
    • faixa 0–1000000000
  • expectedCloseAtstring | nullopcional
  • ownerUserIdstring | nullopcional
  • temperaturestringopcional
    • um de"quente""morno""frio"
  • tagsAddstring[]opcional
    • itens máx. 20
  • tagsRemovestring[]opcional
    • itens máx. 20
  • wonAtstringopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • lostAtstringopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • changeReasonstringopcional
    • tamanho 1–500

Respostas

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

200Deu certoapplication/json

O negócio já com os campos enviados aplicados — só os campos presentes no corpo são tocados.

V1Opportunity

  • 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