Los registros de empresa almacenan datos sobre las empresas. Los endpoints de empresas te permiten administrar estos datos y sincronizarlos entre HubSpot y otros sistemas.
POST
a /crm/v3/objects/companies
.
En tu solicitud, incluye los datos del registro de la empresa en el objeto propiedades. También puedes agregar un objeto de asociaciones para asociar el nuevo registro de empresa con registros existentes (por ejemplo, con contactos o negocios) o con actividades (por ejemplo, con reuniones o notas).
name
o domain
. Se recomienda incluir siempre domain
, porque los nombres de dominio son el identificador único principal para evitar la duplicación de registros de empresa en HubSpot. Si una empresa tiene varios dominios, puedes agregarlos a través de la API utilizando el campo hs_additional_domains
y un punto y coma para separar cada dominio. Por ejemplo: "hs_additional_domains" : "domain.com; domain2.com; domain3.com"
.
Para ver todas las propiedades disponibles, puedes obtener una lista de las propiedades de las empresas de tu cuenta haciendo una solicitud GET
a /crm/v3/properties/companies
. 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 la actividad que deseas asociar con el registro de empresa, especificado por su valor único de id . |
types | El tipo de asociación entre la empresa y el registro o la actividad. 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/companies/{companyId}
.GET
a /crm/v3/objects/companies
.Parámetro | Descripción |
---|---|
properties | Una lista separada por comas de las propiedades que se devolverán en la respuesta. Si el registro de empresa solicitado no tiene un valor para una propiedad, no aparecerá en la respuesta. |
propertiesWithHistory | Una lista separada por comas de las propiedades actuales y anteriores que se devolverán en la respuesta. Si el registro de empresa solicitado no tiene un valor para una propiedad, no aparecerá en la respuesta. |
associations | Una lista separada por comas de los objetos de que obtener 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/companies/batch/read
. El endpoint en bloques no puede obtener asociaciones. Consulta cómo leer asociaciones por lotes con la API de asociaciones.idProperty
para obtener empresas mediante una propiedad de identificador único personalizada. De forma predeterminada, los valores id
de la solicitud se refieren al ID de registro (hs_object_id
), por lo que no se requiere el parámetro idProperty
al obtener información por el ID de registro. Para utilizar una propiedad personalizada de valor único para obtener empresas, debes incluir el parámetro idProperty
.
Por ejemplo, para obtener un lote de empresas, la solicitud podría ser cualquiera de las siguientes:
Para obtener empresas con los valores actuales y anteriores de una propiedad, la solicitud podría ser la siguiente:
PATCH
a /crm/v3/objects/companies/{companyId}
e incluye los datos que quieras 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.PUT
a /crm/v3/objects/companies/{companyId}/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/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
hs_pinned_engagement_id
en la solicitud. En el campo, incluye el id
de la actividad que quieras fijar, que se puede obtener con la API de interacciones. Puedes fijar una actividad por registro, y esa actividad ya debe estar asociada con la empresa antes de fijarla.
Para definir o actualizar la actividad fijada de una empresa, la solicitud podría ser la siguiente:
DELETE
a /crm/v3/objects/companies/{companyId}
.
Consulta más información sobre la eliminación por lotes de empresas en esta documentación de referencia.