Agenda

Concluir atividade da agenda

POST · API de Integração v2

POST/v2/agenda/{id}/concluir

Marca como concluída uma atividade pertencente ao escritório autenticado.

A operação é idempotente: concluir novamente uma atividade já concluída mantém o estado e não gera um novo evento agenda.compromisso.concluido.

Nesta versão, a operação altera somente o estado de conclusão, registra auditoria e publica o webhook. Validações e efeitos adicionais do fluxo legado, como checklist, dependências, lembretes, revisão e notificações, ainda não fazem parte deste contrato.

O corpo é opcional.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de caminho1

idintegerobrigatório

ID da atividade de agenda.

Corpo da requisição

request

application/json

ConcluirAgendaRequest

Respostas5

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 876007,
  "concluido": true
}

Contrato de respostas

200Atividade concluída.

Atividade concluída.

application/json

concluidoboolean

idinteger

formato: int64

400Atividade inválida ou não encontrada para o cliente autenticado, no contrato Problem Details.

Atividade inválida ou não encontrada para o cliente autenticado, no contrato Problem Details.

application/json

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

403Sem permissão para concluir atividades.

Sem permissão para concluir atividades.

O contrato não declara um corpo para esta resposta.

500Erro interno no contrato Problem Details.

Erro interno no contrato Problem Details.

application/json

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

curl --request POST \
  --url 'https://api.expedit.com.br/v2/agenda/1/concluir' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

Nenhum corpo informado.

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 876007,
  "concluido": true
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.