Criar Comentário

Use esse endpoint para deixar comentários sobre o contrato. Eles poderão ser visualizados por qualquer pessoa que tiver acesso ao contrato

POST /comments

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

Exemplo de payload:

{ 
  "comment": { 
    "text": "conteúdo do comentário", 
    "file_id": file_id, 
    "contract_id": contract_id
  } 
}

Descrição do payload:

NameTypeDescription
text *stringconteúdo do comentário
file_idnumberid do arquivo a ser anexado ao comentário
contract_id *numberid do contrato que terá um comentário anexado

🚨 Os campos marcados com * são obrigatórios.

⚠️ Nessa rota, é possível subir um arquivo juntamente com algum comentário, para isso, no payload, é preciso passar o id desse file, mas esse campo não é obrigatório.

Exemplo de resposta:

{
    "data": {
        "contract": {
            "id": 176046
        },
        "edited": false,
        "file": null,
        "id": 1050,
        "inserted_at": "2024-05-31T16:37:50",
        "is_deny": false,
        "text": "conteúdo do comentário",
        "updated_at": "2024-05-31T16:37:50",
        "user": {
            "activated": true,
            "activity": "Desenvolvedor Jr",
            "cpf": "136.382.516-08",
            "email": "[email protected]",
            "first_name": "Davi",
            "gender": "unspecified",
            "id": 3056,
            "last_name": "Ferreira",
            "marital_status": null,
            "organizations_users": null
        }
    }
}