Interacciones | Notas - HubSpot docs

Run in Postman

Requisitos de ámbito

Puedes añadir notas en los registros del CRM para incluir información a la cronología del registro o asociar archivos adjuntos. Por ejemplo, si necesitas hacer seguimiento de una conversación offline que tuviste con un contacto, puedes agregar una nota a su registro de contacto con detalles y documentos relacionados con la conversación. Los demás usuarios de la cuenta podrán ver esa nota y hacer referencia a ella. Puedes gestionar las notas en HubSpot o a través de la API de notas. En este artículo encontrarás los métodos básicos de gestión de notas a través de la API. Puedes ver todos los endpoints disponibles en la documentación de referencia.

Crear una nota

Para crear una nota, haz una solicitud 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).

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:

// Example POST request to https://api.hubspot.com/crm/v3/objects/notes
{
  "properties": {
    "hs_timestamp": "2021-11-12T15:48:22Z",
    "hs_note_body": "Spoke with decision maker Carla. Attached the proposal and draft of contract.",
    "hubspot_owner_id": "14240720",
    "hs_attachment_ids": "24332474034;24332474044"
  },
  "associations": [
    {
      "to": {
        "id": 301
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 190
        }
      ]
    },
    {
      "to": {
        "id": 401
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 214
        }
      ]
    }
  ]
}

El objeto asociaciones, debe incluir lo 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.

Más información sobre la creación de notas por lotes en la documentación de referencia.

Buscar notas

Puedes buscar notas individualmente o por lotes. Para buscar una nota individual, haz una solicitud 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.

Por ejemplo, para obtener las notas con el contenido del texto y cualquier ID de contacto asociado, la URL de la solicitud puede ser similar a este: 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 solicitud PATCH a /crm/v3/objects/notes/{noteId}. En el cuerpo de la solicitud, incluye las propiedades de nota que deseas actualizar:

// Example PATCH request to https://api.hubspot.com/crm/v3/objects/notes/{noteID}
{
  "properties": {
    "hs_note_body": "Spoke with decision maker Carla.",
    "hs_attachment_ids": "24332474034;24332474044"
  }
}

HubSpot ignorará los valores de las propiedades de solo lectura e inexistentes. Para borrar el valor de una propiedad, pasa una cadena vacía para esa propiedad en el cuerpo de la solicitud. Más información sobre la actualización de notas por lotes en la documentación de referencia.

Asociar notas existentes con registros

Para asociar una nota con otros registros del CRM, como un contacto, haz una solicitud 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.

Por ejemplo, la URL de la solicitud puede verse similar al siguiente: 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 solicitud DELETE 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 el 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.

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 solicitud DELETE a /crm/v3/objects/notes/{noteId}. Más información sobre la eliminación de notas en la documentación de referencia.

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Eventos

Archivos

Marketing

Programador

Webhooks

Interacciones | Notas

Run in Postman

Crear una nota

Propiedades

Asociaciones

Buscar notas

Actualizar notas

Asociar notas existentes con registros

Eliminar una asociación

Anclar una nota a un registro

Eliminar notas

Run in Postman

​Crear una nota

​Propiedades

​Asociaciones

​Buscar notas

​Actualizar notas

​Asociar notas existentes con registros

​Eliminar una asociación

​Anclar una nota a un registro

​Eliminar notas

Crear una nota

Propiedades

Asociaciones

Buscar notas

Actualizar notas

Asociar notas existentes con registros

Eliminar una asociación

Anclar una nota a un registro

Eliminar notas