Los registros de contactos almacenan información sobre las personas. Los endpoints de contactos te permiten gestionar estos datos y sincronizarlos entre HubSpot y otros sistemas.
POST
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).
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. |
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. |
GET
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.
PATCH
a /crm/v3/objects/notes/{noteId}
.
En el cuerpo de la solicitud, incluye las propiedades de nota que deseas actualizar:
PUT
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
DELETE
a la misma URL que la anterior:
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
id
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.
DELETE
a /crm/v3/objects/notes/{noteId}
.
Más información sobre la eliminación de notas en la documentación de referencia.