/deals/{dealId}/notesCrear nota de oportunidad
Agrega una nota a una oportunidad.
POST https://api.getincloud.ai/v1/deals/{dealId}/notesAgrega una nota a una oportunidad.
Envía dueAt para convertirla en una tarea: la nota se mostrará entonces como trabajo pendiente hasta que
alguien la complete. Omítelo para una nota simple.
Envía event con el id de uno de los eventos de la propia oportunidad (consulta
GET /deals/{dealId}/events) para adjuntar la nota como comentario bajo ese
evento en el historial de actividad del registro.
Envía files con los ids de hasta 3 archivos subidos previamente
mediante POST /files para adjuntarlos a la nota. Los tipos aceptados son imágenes JPEG,
PNG y WebP, PDF, Word, Excel, PowerPoint, texto plano y Markdown,
de hasta 10 MB cada uno. Súbelos con permission=public para que todos los compañeros que
puedan leer la oportunidad puedan abrirlos. Los archivos adjuntos se marcan como protegidos y
nunca los elimina la limpieza de retención de archivos.
Envía el encabezado Idempotency-Key con un id hexadecimal de 24 caracteres que generes tú
mismo para que la creación sea segura de reintentar: el id pasa a ser el de la nota,
por lo que repetir la misma solicitud devuelve la nota que creó la primera
en lugar de agregar una segunda.
Nota: este recurso de la API está disponible en la suscripción Platform Professional y superiores.
Prueba este endpoint en el probador de API en vivo
>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.
Autenticación
Envía tu API key en el encabezado Token en cada petición.
Parámetros
| Campo | Dónde | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
Idempotency-Key | header | string | No | Opcional. Un ObjectId hexadecimal de 24 caracteres generado por el cliente, que se usa como id propio de la nota. Reintentar una solicitud con la misma clave devuelve la nota que ya creó, con el mismo 200 y el mismo cuerpo, en lugar de crear un duplicado. pattern: ^[0-9a-fA-F]{24}$ |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
text | string | Sí | Contenido de la nota. Obligatorio minLength: 1 · maxLength: 2000 |
dueAt | string | No | Fecha de vencimiento. Una nota que la tiene es una tarea format: date-time |
event | string | No | Id de uno de los eventos de la propia oportunidad. La nota se convierte en un comentario anidado bajo ese evento en el historial del registro pattern: ^[a-f0-9]{24}$ |
files | array<string> | No | Ids de hasta 3 archivos subidos previamente para adjuntar a la nota. Súbelos primero con POST /files |
Respuestas
| Código | Descripción |
|---|---|
200 | Nota creada, o la nota que ya creó una solicitud anterior con el mismo Idempotency-Key |
400 | Carga de la nota no válida, un Idempotency-Key con formato incorrecto, o un adjunto que no existe, es demasiado grande o es de un tipo no admitido |
401 | No autorizado - Token de API no válido o ausente |
403 | Operación no admitida - se requiere actualizar el plan |
404 | Oportunidad no encontrada |
409 | El Idempotency-Key proporcionado ya está en uso por una nota fuera de esta oportunidad |
429 | Se alcanzó el número máximo de notas por oportunidad |
500 | Error inesperado |
501 | No implementado |
503 | Servicio no disponible temporalmente - Inténtalo de nuevo más tarde |