Pular para o conteúdo
Funil

Marcar negócio como ganho

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

wonAt (ou closedOn, o mesmo campo com o nome antigo) é o dia real do ganho, AAAA-MM-DD no fuso da conta; omitido = hoje. Não pode ser futuro; anterior à criação do negócio vale (o caso da migração de outro CRM). Com um dia diferente de hoje, o registro entra na trilha de datas do negócio com a note. Os relatórios contam o ganho pelo wonAt; wonRecordedAt é sempre o momento da chamada.

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
  • valueCentsinteger | nullopcional
    • faixa 0–1000000000
  • closedOnstring | nullopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • wonAtstring | nullopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • notestring | nullopcional
    • tamanho máx. 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 fechado como ganho, já movido para o estágio de ganho do funil. wonAt é o dia real do fechamento (closedOn no corpo, ou hoje) e wonRecordedAt é o momento do registro. valueCents no corpo sobrescreve o valor do negócio.

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