Pular para o conteúdo
Contatos

Adicionar ou remover etiquetas

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

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
  • tagsstring[]obrigatório
    • itens 1–20
  • modestringopcional
    • padrão "add"
    • um de"add""remove"

Respostas

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

200Deu certoapplication/json

O contato com a lista de etiquetas já resultante da operação (união em add, subtração em remove).

V1Contact

  • idstring
  • namestring
  • phonestring | null
  • emailstring | null
  • companystring | null
  • companyIdstring | null
  • rolestring | null
  • cpfstring | null
  • notesstring | null
  • tagsstring[]
  • statusstring
    • um de"active""archived""merged"
  • ownerUserIdstring | null
  • originstring
  • customFieldsobjeto livre
    • chave string
    • valor qualquer valor JSON
  • createdAtstring
  • updatedAtstring
  • urlstring
    • sourcestring | null
    • mediumstring | null
    • campaignstring | null
    • termstring | null
    • contentstring | null
  • firstHumanTouchAtstring | nullpode faltar
  • lastHumanTouchAtstring | nullpode faltar
  • humanTouchCountintegerpode faltar

    Quantos toques humanos este contato recebeu (cada mensagem, ligação, e-mail ou nota com actor: "user" em /interactions conta um). 0 = nenhum. Mesma fonte de firstHumanTouchAt/lastHumanTouchAt; só vem em GET /contacts/{id}.

    • mín. 0
  • firstHumanTouchChannelstring | nullpode faltar

    O canal do PRIMEIRO toque humano — 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 = nunca houve toque humano.