Pular para o conteúdo
GET

/v1/owner-structured/state

Estado para o agente: tipos com gravação direta e alteração aguardando o "sim" nesta conversa

Uma leitura por turno do dono. direct = tipos que o agente pode gravar direto nesta versão, com os tópicos do juiz que caem em cada um. openChange = a alteração desta conversa que ainda pode ser confirmada: aguardando_confirmacao, dentro de 24 h e cuja pergunta de confirmação foi a última coisa que o atendimento enviou (exatamente uma mensagem enviada desde a apresentação). Fora disso vem null: um "sim" não se refere a ela.

Qualquer uma:services:writeservices:price_write_as_owner

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de consulta

  • conversationIdstringObrigatório

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/owner-structured/state?conversationId=<conversationId>", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "direct": [      {        "kind": "<kind>",        "topics": [          "<topic>"        ]      }    ],    "openChange": {      "id": "<id>",      "kind": "service_price",      "status": "aguardando_confirmacao",      "service": {        "id": "<id>",        "key": "<key>",        "name": "<name>"      },      "proposed": {        "period": "avulso",        "sessions": 1,        "price": 1      },      "current": {        "price": 1      },      "replaces": true,      "origin": "dono_whatsapp",      "sourceMessageId": "<sourceMessageId>",      "confirmationMessageId": "<confirmationMessageId>",      "informedByMembershipId": "<informedByMembershipId>",      "summary": "<summary>",      "proposedAt": "2026-09-18T14:00:00.000Z",      "expiresAt": "2026-09-18T14:00:00.000Z",      "appliedAt": "2026-09-18T14:00:00.000Z"    }  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites