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/contacts
.
En tu solicitud, incluye los datos del contacto en el objeto propiedades. También puedes agregar un objeto asociaciones para asociar el nuevo registro de contacto con los registros existentes (por ejemplo, empresas o negocios) o actividades (por ejemplo, reuniones o notas).
email
, firstname
o lastname
. Se recomienda siempre incluir email
, ya que la dirección de correo electrónico es el identificador único principal para evitar la duplicación de registros de contactos en HubSpot.
Para ver todas las propiedades disponibles, puedes obtener una lista de las propiedades de contacto de tu cuenta haciendo una solicitud GET
a /crm/v3/properties/contacts
. Encuentra más información sobre la API de propiedades.
lifecyclestage
en la solicitud, los valores deben referirse al nombre interno de la etapa del ciclo de vida. Los nombres internos de las etapas predeterminadas son valores de texto y no cambian aunque edites la etiqueta de la etapa (por ejemplo, subscriber
o marketingqualifiedlead
). Los nombres internos de las etapas personalizadas son valores numéricos. Puedes encontrar el ID interno de una etapa en la configuración de la etapa del ciclo de vida u obteniendo la propiedad de la etapa del ciclo de vida a través de la API.Parámetro | Descripción |
---|---|
to | El registro o actividad que quieres asociar con el contacto, especificado por su valor id único. |
types | El tipo de asociación entre el contacto y el registro o actividad. Incluye associationCategory y associationTypeId . Los ID de los tipos de asociación predeterminados se enumeran en este recurso, y también 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/contacts/{contactId} or
/crm/v3/objects/contacts/{email}?idProperty=email
.GET
a /crm/v3/objects/contacts
.Parámetro | Descripción |
---|---|
properties | Una lista separada con comas de las propiedades que se devolverán en la respuesta. Si el registro de contacto solicitado no tiene un valor para una propiedad, este no aparecerá en la respuesta. |
propertiesWithHistory | Una lista separada con comas de las propiedades actuales y anteriores que se devolverán en la respuesta. Si el registro de contacto solicitado no tiene un valor para una propiedad, este no aparecerá en la respuesta. |
associations | Una lista separada con comas de los objetos para los que se deben obtener los ID asociados. No se devolverán en la respuesta las asociaciones especificadas que no existan. Encuentra más información sobre la API de asociaciones. |
POST
a crm/v3/objects/contacts/batch/read
. El endpoint por lotes no puede obtener asociaciones. Encuentra más información sobre cómo leer asociaciones por lotes con la API de asociaciones.idProperty
para buscar contactos por email
o por una propiedad de identificador único personalizado. De forma predeterminada, los valores id
de la solicitud se refieren al ID del registro (hs_object_id
), por lo que no se requiere el parámetro idProperty
al buscar por el ID del registro. Si estás utilizando email
o una propiedad de valor único personalizado para buscar contactos, debes incluir el parámetro idProperty
.
Por ejemplo, para buscar un lote de contactos en función de los valores de ID del registro, tu solicitud podría verse así (solo valores actuales o valores actuales y antiguos):
Para buscar contactos en función del correo electrónico o una propiedad de identificador único personalizado (por ejemplo, un número de identificación de cliente único para tu empresa), tu solicitud sería la siguiente:
id
) o la dirección de correo electrónico del contacto (email
).
PATCH
a /crm/v3/objects/contacts/{contactId}
e incluye los datos que quieres actualizar.PATCH
a /crm/v3/objects/contacts/{email}?idProperty=email
e incluye los datos que quieres actualizar.lifecyclestage
, solo puedes elegir una etapa posterior en el orden de las etapas. Para retroceder la etapa del ciclo de vida a un valor anterior, primero deberás eliminar el valor actual de la etapa del ciclo de vida del registro. El valor se puede borrar manualmente, o se puede eliminar automáticamente mediante un workflow o una integración que sincronice los datos de los contactos.id
). Para actualizar varios registros de contactos, haz una solicitud POST
a /crm/v3/objects/contacts/batch/update
En el cuerpo de la solicitud, incluye el ID de registro de cada contacto como el id
e incluye las propiedades que quieres actualizar.
Por ejemplo:
email
o una propiedad de identificador único personalizado. Tras la solicitud, si los contactos ya existen, se actualizarán y si no existen, se crearán.
Para crear y actualizar contactos, envía una solicitud POST
a /crm/v3/objects/contacts/batch/upsert
. En el cuerpo de la solicitud, incluye el parámetro idProperty
para identificar si estás utilizando email
o una propiedad de identificador único personalizado. Incluye el valor de esa propiedad como id
y añade las demás propiedades que quieres establecer o actualizar.
email
como idProperty
para los contactos. Para completar un upsert parcial, utiliza en su lugar una propiedad de identificador único personalizado como idProperty
.PUT
a /crm/v3/objects/contacts/{contactId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
associationTypeId
, consulta esta lista de valores predeterminados o haz una solicitud GET
a /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.DELETE
a la siguiente URL: /crm/v3/objects/contacts/{contactID}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
hs_pinned_engagement_id
en tu solicitud. En el campo, incluye el id
de la actividad que quieres anclar, que se puede obtener a través de las API de interacciones. Puedes anclar una actividad por registro, y la actividad ya debe estar asociada con el contacto antes de anclarla.
Para establecer o actualizar la actividad anclada de un contacto, la solicitud podría hacerse de la siguiente manera:
DELETE
a /crm/v3/objects/contacts/{contactId}
.
Consulta más información sobre la eliminación por lotes de contactos en esta documentación de referencia.
properties
con las propiedades email
y hs_additional_emails
. La dirección de correo electrónico principal de un contacto se mostrará en el campo email
y los correos electrónicos adicionales se mostrarán en el campo hs_additional_emails
.