Empresas 

ResumenPuntos de terminación

En HubSpot, los registros de empresa almacenan información sobre las organizaciones que interactúan con tu empresa. Los puntos de terminación de las empresas te permiten crear y administrar registros de empresa, así como sincronizar los datos de los registros de empresa entre HubSpot y otros sistemas. 

Obtén más información sobre las API de objetos, registros, propiedades y asociaciones en la guía Comprender el CRM. Para obtener más información general sobre objetos y registros de HubSpot, aprende a administrar la base de datos del CRM.

Crear empresas

Para crear nuevos registros de empresa, haz una solicitud POST en /crm/v3/objects/companies.

En tu solicitud, incluye los datos del registro de empresa en el objeto propiedades. También puedes agregar el objeto asociaciones para asociar el nuevo registro de empresa con registros existentes (por ejemplo, contactos, negocios) o actividades (por ejemplo, reuniones, notas).

Propiedades

Los detalles de la empresa se almacenan en las propiedades de empresa. 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 con puntos y coma separando cada dominio. Por ejemplo: "hs_additional_domains" : "domain.com; domain2.com; domain3.com".

Para ver todas las propiedades disponibles, puedes recuperar una lista de las propiedades de empresa de tu cuenta haciendo una solicitud GET en /crm/v3/properties/companies. Más información sobre la API de propiedades.

Nota: si has incluido lifecyclestage en tu 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 incluso si editas 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 o recuperando la propiedad de la etapa del ciclo de vida a través de la API.

Por ejemplo, para crear un nuevo registro de empresa, tu solicitud puede ser similar a la siguiente:

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" } }

Asociaciones

Al crear un nuevo registro de empresa, también puedes asociarlo con registros o actividades existentes. En el objeto asociaciones, incluye los siguientes campos:

Use this table to describe parameters / fields
ParameterDescription
toObjectId

El ID del registro o actividad con los que deseas asociar el registro de empresa.

associationTypeId

Un identificador único para indicar el tipo de asociación entre el registro de empresa y el otro objeto o actividad. Los tipos de asociación predeterminados se muestran aquí, o puedes recuperar el valor haciendo una solicitud GET a/crm/v4/associations/{fromObjectType}/{toObjectType}/labels. Más información sobre la API de asociaciones.

También puedes incluir el campo label para asignar una etiqueta de asociación definida que describa la asociación. Más información sobre cómo asociar registros a través de la API 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:

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" }, "associations": [ { "to": { "id": 101 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 280 } ] }, { "to": { "id": 556677 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 185 } ] }] }

Recuperar registros de empresa

Puedes recuperar registros de empresa individualmente o en lotes.

  • Para recuperar un registro de empresa individual, haz una solicitud GET en /crm/v3/objects/companies/{companyId}.
  • Para recuperar una lista de todos los registros de empresa, haz una solicitud GET en /crm/v3/objects/companies.

En estos puntos de terminación, puedes incluir los siguientes parámetros de consulta en la URL de la solicitud: 

Use this table to describe parameters / fields
ParameterDescription
propiedades

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 e históricas 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.

asociaciones

Una lista separada por comas de los objetos de los cuales recuperar los ID asociados. No se devolverán en la respuesta las asociaciones especificadas que no existan. Más información sobre la API de asociaciones.
  • Para recuperar un lote de empresas específicas por ID de registro o una propiedad de identificador único personalizado, haz una solicitud POST a crm/v3/objects/companies/batch/read. El punto de terminación por lote no puede recuperar asociaciones. Más Más información sobre cómo leer asociaciones por lotes con la API de asociaciones.

Para el punto de terminación de lectura por lotes, también puedes usar el parámetro opcional idProperty para recuperar empresas mediante una propiedad de identificador único personalizado. Por opción predeterminada, los valores de id en la solicitud se refieren al ID de registro (hs_object_id), por lo que no se requiere el parámetro idProperty al recuperar por ID de registro. Para utilizar una propiedad de valor único personalizada para recuperar empresas, debes incluir el parámetro idProperty.

Por ejemplo, para recuperar un lote de empresas, tu solicitud podría ser cualquiera de las siguientes:

///Example request body with record ID { "properties": [ "name", "domain" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }
///Example request body with a unique value property { "properties": [ "name", "domain" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }

Para recuperar empresas con valores actuales e históricos para una propiedad, tu solicitud podría ser la siguiente:

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "name" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }

Actualizar registros de empresa

Puedes actualizar los registros de empresa individualmente o por lotes. Para los registros de empresa existentes, el ID de la empresa es un valor único que puedes usar para actualizar el registro de empresa a través de la API.

Para actualizar una empresa individual por su ID de empresa, realiza una solicitud PATCH en /crm/v3/objects/companies/{companyId}, e incluye los datos que deseas actualizar.

Asociar registros de empresa existentes con registros y actividades

Para asociar un registro de empresa con otros registros del CRM o con una actividad, haz una solicitud PUT en  /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}. 

Para recuperar el valor associationTypeId, consulta esta lista de valores predeterminados o haz una solicitud GET a/crm/v4/associations/{fromObjectType}/{toObjectType}/labels. 

Más información sobre cómo asociar registros a través de la API de asociaciones.

Eliminar una asociación

Para eliminar una asociación entre un registro de empresa y un registro o actividad, haz una solicitud DELETE en la siguiente URL: /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Eliminar registros de empresa

Puedes eliminar registros de empresa individualmente o por lotes, lo que agregará el registro de empresa a la papelera de reciclaje en HubSpot. Más tarde puedes restaurar el registro de empresa dentro de HubSpot.

Para eliminar un registro de empresa individual por su ID, haz una solicitud DELETE en /crm/v3/objects/companies/{companyId}.

Obtén más información sobre la eliminación de registros de empresa por lotes en la pestaña Puntos de terminación en la parte superior de este artículo.

¿Te resultó útil este artículo?
Con este formulario puedes enviar tu opinión sobre nuestros documentos para desarrolladores. Si tienes comentarios sobre el producto de HubSpot, puedes enviarlos al Foro de ideas.