Agenda
Criar comentário de uma atividade de agenda
POST · API de Integração v2
POST
/v2/agenda/{agendaId}/comentariosO título e a data são definidos pelo servidor. Anexos devem já pertencer à atividade. O vínculo com processo só ocorre quando vincularAoProcesso for verdadeiro.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
agendaIdintegerobrigatórioagendaId
Corpo da requisiçãoobrigatório
request
application/json
anexosIdsinteger[]IDs de arquivos já anexados à própria agenda.
exemplo: [12,13]
comentariostringobrigatórioTexto do comentário.
exemplo: Solicitado retorno do cliente.
mencoesUsuariosIdsinteger[]IDs de usuários ativos do cliente mencionados no comentário.
exemplo: [1649,2754]
vincularAoProcessobooleanQuando verdadeiro, torna o comentário também visível no processo vinculado à agenda.
exemplo: false
Respostas1
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 ilustrativo gerado do schema · application/json
{
"agendaId": 1,
"anexos": [
{
"id": 1,
"nome": "string",
"url": "string"
}
],
"autor": {
"fotoUrl": "string",
"id": 1,
"nome": "string"
},
"autorId": 1,
"comentario": "string",
"criadoEm": "string",
"data": "yyyy-MM-dd",
"id": 1,
"mencoesUsuariosIds": [
1
],
"processoId": 1,
"titulo": "string"
}Contrato de respostas
200OK
OK
application/json
agendaIdintegerformato: int64
anexosAnexoComentarioAgenda[]Ver propriedades
idintegerformato: int64
nomestringurlstringautorAutorComentarioAgendaVer propriedades
fotoUrlstringidintegerformato: int64
nomestringautorIdintegerformato: int64
comentariostringcriadoEmstringdatastringexemplo: yyyy-MM-dd
idintegerformato: int64
mencoesUsuariosIdsinteger[]processoIdintegerformato: int64
titulostring