Pular para o conteúdo
Ações

Acompanhar uma Ação

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/actions/{id}
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposactions.read

O estado de uma Ação pedida por esta chave — é o endereço do Location da resposta 202 de uma escrita que ficou pendente de aprovação. O corpo do pedido (args) não volta: quem pediu já o tem.

Parâmetros de caminho

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

  • idstringobrigatório
    • tamanho 1–64

Respostas

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

200Deu certoapplication/json

A Ação, com o status e a decisão (quando houver).

V1Action

  • idstring
  • object"action"
    • sempre "action"
  • statusstring

    pending_approval (esperando o dono), done, rejected (veja rejectionReason), expired (ninguém decidiu no prazo) ou failed (aprovada, mas a execução falhou — veja error). approved/executing são instantes de transição.

    • um de"pending_approval""approved""executing""done""rejected""expired""failed"
  • actionTypestring

    O verbo do Núcleo (contact.update, opportunity.move…).

  • approvalAreastring | null

    A área do dial de autonomia que governou o pedido (null = interna).

  • createdAtstring
  • expiresAtstring | null

    Até quando o dono pode decidir. null = a Ação nunca ficou pendente.

  • decidedAtstring | null
  • rejectionReasonstring | null
  • errorstring | null

  • O recurso que a Ação tocou (contact, opportunity…), quando houver.

    • typestring
    • idstring