Última modificación: 22 de agosto de 2025
Run in Postman
Crear una nota
Para crear una nota, haz una solicitudPOST
a /crm/v3/objects/notes
.
En el cuerpo de la solicitud, agrega detalles de la nota en el objeto propiedades. También puedes agregar el objeto asociaciones para asociar la nueva nota con un registro existente (por ejemplo, contactos o empresas).
Propiedades
En el objeto propiedades, puedes incluir los siguientes campos:Campo | Descripción |
---|---|
hs_timestamp | Requerido. Este campo marca la hora de creación de la nota y determina dónde se encuentra la nota en la cronología del registro. Puedes usar una marca de tiempo Unix en milisegundos o en formato UTC. |
hs_note_body | El contenido del texto de la nota está limitado a 65.536 caracteres. |
hubspot_owner_id | El ID del propietario asociado con la nota. Este campo determina el usuario que aparece como creador de la nota en la cronología del registro. |
hs_attachment_ids | Los ID de los archivos adjuntos a la nota. Los ID de varios archivos adjuntos deben estar separados por un punto y coma. |
Asociaciones
Para crear y asociar una nota con registros existentes, incluye un objeto de asociaciones en la solicitud. Por ejemplo, para crear una nota y asociarla con una empresa y un negocio, el cuerpo de la solicitud podría ser similar a la siguiente:Campo | Descripción |
---|---|
to | El registro que quieres asociar con la nota, especificado por el valor de id único. |
types | El tipo de asociación entre la nota y el registro. Incluye associationCategory y associationTypeId . Los ID de los tipos de asociación predeterminados se enumeran en esta página, o puedes obtener el valor de los tipos de asociación personalizados (es decir, etiquetas) a través de la API de asociaciones. |
Buscar notas
Puedes buscar notas individualmente o por lotes. Para buscar una nota individual, haz una solicitudGET
a /crm/v3/objects/notes/{noteId}
.
Para obtener una lista de todas las notas, haz una solicitud GET
a /crm/v3/objects/notes
.
En estos endpoints, puedes incluir los siguientes parámetros de consulta en la URL de la solicitud:
Parámetro | Descripción |
---|---|
properties | Una lista separada con comas de las propiedades que estarán en la respuesta. Si la nota solicitada no tiene un valor en la propiedad, no aparecerá en la respuesta. |
associations | Una lista separada por comas de los tipos de objetos para obtener los ID asociados. En la respuesta no aparecerán las asociaciones especificadas que no existan. Encuentra más información sobre la API de asociaciones. |
https://api.hubapi.com/crm/v3/objects/notes?limit=10&properties=hs_note_body&associations=contact&archived=false
.
Obtén más información sobre cómo obtener un lote de notas por el ID interno o el valor de propiedad único en la documentación de referencia.
Actualizar notas
Puedes actualizar las notas individualmente o por lotes. Para actualizar una nota individual por su ID, haz una solicitudPATCH
a /crm/v3/objects/notes/{noteId}
.
En el cuerpo de la solicitud, incluye las propiedades de nota que deseas actualizar:
Asociar notas existentes con registros
Para asociar una nota con otros registros del CRM, como un contacto, haz una solicitudPUT
a /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
. La URL de la solicitud contiene los siguientes campos:
Campo | Descripción |
---|---|
noteId | El ID de la nota. |
toObjectType | El tipo de objeto con el que quieres asociar la nota (por ejemplo, contacto o empresa) |
toObjectId | El ID del registro con el que quieres asociar la nota. |
associationTypeId | Un identificador único para indicar el tipo de asociación entre la nota y el otro objeto. El ID se puede representar de forma numérica o con palabras separadas por un guion bajo (por ejemplo, note_to_contact ). Puedes obtener el valor a través de la API de asociaciones. |
https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202
Eliminar una asociación
Para eliminar una asociación entre una nota y un registro, haz una solicitudDELETE
a la misma URL que la anterior:
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Anclar una nota a un registro
Puedes anclar una nota en un registro para que permanezca en la parte superior de la cronología del registro. La nota debe estar asociada al registro antes de poder anclarla, y solo se puede anclar una actividad por registro. Para anclar una nota, incluye elid
de la nota en el campo hs_pinned_engagement_id
al crear o actualizar un registro a través de las API de objetos. Obtén más información sobre el uso de las API de empresas, contactos, negocios, tickets y objetos personalizados.
Eliminar notas
Puedes eliminar notas individualmente o por lotes, lo que agregará la nota a la papelera de reciclaje en HubSpot. Más tarde podrás restaurar la nota desde la cronología del registro. Para eliminar una sola nota usando su ID, haz una solicitudDELETE
a /crm/v3/objects/notes/{noteId}
.
Más información sobre la eliminación de notas en la documentación de referencia.