Skip to main content
POST
Add note to a document

Authorizations

api-key
string
header
required

API key provista por Payana.

Path Parameters

reference
string
required

Referencia interna del documento en Payana (UUID, ej. aaea7db4-647c-4d92-9f86-89e34a68e1aa).

Body

Cuerpo para crear una nota en formato JSON. Debe incluir al menos comment o file_path.

comment
string

Comentario de texto de la nota.

Maximum string length: 5000
file_path
string<uri>

URL pública (http/https) de un archivo ya alojado. Extensiones permitidas: pdf, jpg, jpeg, png.

Maximum string length: 2048
file_name
string

Nombre del archivo. Si se provee, file_path es obligatorio. Si se omite, se infiere desde file_path.

Maximum string length: 255

Response

Note created

Nota pública de un documento (comentario y/o archivo adjunto).

comment
string | null

Comentario de texto de la nota.

file_path
string | null

URL del archivo adjunto, si la nota tiene uno.

file_name
string | null

Nombre del archivo adjunto, si la nota tiene uno.

created_by
object

Autor de la nota.

created_at
string<date-time> | null
updated_at
string<date-time> | null