Última modificación: 22 de agosto de 2025
Run in Postman
Crear empresas
Para crear nuevas empresas, haz una solicitudPOST
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).
Propiedades
Los detalles de empresas se almacenan en las propiedades de empresas. Hay propiedades de empresa de HubSpot predeterminadas, pero también puedes crear propiedades personalizadas. Al crear un nuevo registro de empresa, debes incluir al menos una de las siguientes propiedades en tu solicitud: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.
Nota:
Si has incluidolifecyclestage
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.Asociaciones
Al crear un nuevo registro de empresa, también puedes asociarlo con registros o actividades existentes en un objeto de asociaciones. Por ejemplo, para asociar un nuevo registro de empresa con un registro de contacto y correo electrónico existentes, tu solicitud se vería de la siguiente manera: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. |
Obtener registros de empresa
Puedes obtener registros de empresa de forma individual o en lotes.- Para obtener un registro de empresa individual, haz una solicitud
GET
a/crm/v3/objects/companies/{companyId}
. - Para solicitar una lista de todas las empresas, haz una solicitud
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. |
- Para obtener un lote de empresas específicas por el ID de registro o una propiedad de identificador único personalizado, haz una solicitud
POST
acrm/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:
Actualizar empresas
Puedes actualizar los registros de empresa individualmente o por lotes. Con los registros de empresas existentes, el ID de la empresa es un valor único que puedes usar para actualizar el registro de la empresa a través de la API. Para actualizar un registro de empresa individual por su ID de registro de empresa, haz una solicitudPATCH
a /crm/v3/objects/companies/{companyId}
e incluye los datos que quieras actualizar.
Nota:
Si actualizas la propiedadlifecyclestage
, 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.Asociar las empresas existentes con registros y actividades
Para asociar un registro de empresa con otros registros del CRM o una actividad, haz una solicitudPUT
a /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Para obtener el valor
associationTypeId
, consulta esta lista de valores predeterminados o haz una solicitud GET
a /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.Eliminar una asociación
Para eliminar una asociación entre un registro de empresa y un registro o actividad, realiza una solicitudDELETE
a la siguiente URL: /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Fijar una actividad en un registro de empresa
Puedes anclar una actividad en un registro de empresa a través de la API incluyendo el campohs_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:
Eliminar empresas
Puedes eliminar registros de empresas individualmente o por lotes, lo que agregará el registro de empresa a la papelera de reciclaje en HubSpot. Más tarde puedes restaurar ese registro en HubSpot. Para eliminar una empresa individual por su ID, haz una solicitudDELETE
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.