Confirmar visualização da entrega digital do protocolo

Permite confirmar a visualização da entrega digital do protocolo vinculado ao escritório.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades enviadas

Request body

  • contactId - Id do contato do cliente que visualizou o documento. O contato precisa pertencer ao cliente informado e ter acesso ao departamento da obrigação do protocolo.

Comportamento

  • O protocolo passa para a situação Visualizado e o evento Documento visualizado entra no histórico em nome do contato informado.
  • Protocolo pago continua com a situação Pago.

Erros

  • 400 - contactId não informado, ou o contato não tem acesso ao documento.
  • 403 - o usuário não tem permissão sobre o protocolo.
  • 404 - cliente, contato ou protocolo não encontrado.
  • 422 - o protocolo não é de entrega digital para o cliente, ou está cancelado.
Path Params
string
required

Id do escritório.

string
required

Id do cliente.

string
required

Id do protocolo.

Body Params
string
Defaults to Obrigatório.

Id do contato do cliente que visualizou o documento.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json