> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# API de CRM | Empresas
export const postmanIcon = ;
export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
;
};
# Empresas
En HubSpot, los registros de empresa almacenan información sobre las organizaciones que interactúan con tu empresa. Los endpoints de las empresas te permiten crear y administrar registros de empresas, así como sincronizar los datos de los registros de empresas entre HubSpot y otros sistemas.
Obtén más información sobre las API de los objetos, los registros, las propiedades y las asociaciones en la [guía informativa sobre el CRM](/guides/crm/understanding-the-crm). Para obtener más información general sobre los objetos y registros de HubSpot, [consulta cómo administrar la base de datos del CRM](https://knowledge.hubspot.com/get-started/manage-your-crm-database).
## Crear empresas
Para crear nuevas empresas, haz una solicitud `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).
### Propiedades
Los detalles de empresas se almacenan en las propiedades de empresas. Hay propiedades de empresa de HubSpot [predeterminadas](https://knowledge.hubspot.com/properties/hubspot-crm-default-company-properties), pero también puedes [crear propiedades personalizadas](https://knowledge.hubspot.com/properties/create-and-edit-properties).
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](https://knowledge.hubspot.com/records/deduplication-of-records#automatic-deduplication-in-hubspot) para evitar la duplicación de registros de empresa en HubSpot. Si una empresa tiene [varios dominios](https://knowledge.hubspot.com/records/add-multiple-domain-names-to-a-company-record), 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](/api-reference/crm-properties-v3/guide).
### Nota:
Si has incluido `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 ](https://knowledge.hubspot.com/properties/create-and-edit-properties#:~:text=the%20properties%20settings.-,Label/Name%3A,-enter%20a%20unique) (por ejemplo, `subscriber` o `marketingqualifiedlead`). Los nombres internos de las [etapas personalizadas](https://knowledge.hubspot.com/object-settings/create-and-customize-lifecycle-stages) son valores numéricos. Puedes encontrar el ID interno de una etapa en la [configuración de la etapa del ciclo de vida](https://knowledge.hubspot.com/object-settings/create-and-customize-lifecycle-stages#:~:text=To%20edit%20a%20lifecycle%20stage%2C%20hover%20over%20the%20stage%20and%20click%20Edit.%20In%20the%20right%20panel%2C%20edit%20the%20Stage%20name%2C%20then%20click%20Edit%20lifecycle%20stage%20to%20confirm.%20Click%20the%20code%20codcode%20icon%20to%20view%20the%20stage%27s%20internal%20ID%2C%20which%20is%20used%20by%20integrations%20and%20APIs.) u obteniendo la propiedad de la etapa del ciclo de vida a través de la API.
Por ejemplo, para crear un nuevo registro de empresa, la solicitud puede ser similar a la siguiente:
```json theme={null}
///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](https://knowledge.hubspot.com/records/associate-records) o [actividades](https://knowledge.hubspot.com/records/associate-activities-with-records) 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:
```json theme={null}
///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
}
]
}
]
}
```
Para el objeto asociaciones, debes incluir lo siguiente:
| 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](/api-reference/crm-associations-v4/guide#association-type-id-values), o puedes obtener el valor de los tipos de asociación personalizados (es decir, etiquetas) a través de la [API de asociaciones](/api-reference/crm-associations-v4/guide#retrieve-association-types). |
## 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`.
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 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.](/api-reference/crm-associations-v4/guide) |
* Para obtener un lote de empresas específicas por el ID de registro o una [propiedad de identificador único personalizado](/api-reference/crm-properties-v3/guide#create-unique-identifier-properties), haz una solicitud `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](/api-reference/crm-associations-v4/guide).
Con el endpoint de lectura por lotes, también puedes utilizar el parámetro opcional `idProperty` para obtener empresas mediante una [propiedad de identificador único](/api-reference/crm-properties-v3/guide#create-unique-identifier-properties) 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:
```json theme={null}
///Example request body with record ID
{
"properties": ["name", "domain"],
"inputs": [
{
"id": "56789"
},
{
"id": "23456"
}
]
}
```
```json theme={null}
///Example request body with a unique value property
{
"properties": ["name", "domain"],
"idProperty": "uniquepropertyexample",
"inputs": [
{
"id": "abc"
},
{
"id": "def"
}
]
}
```
Para obtener empresas con los valores actuales y anteriores de una propiedad, la solicitud podría ser la siguiente:
```json theme={null}
///Example request body with record ID (current and historical values)
{
"propertiesWithHistory": ["name"],
"inputs": [
{
"id": "56789"
},
{
"id": "23456"
}
]
}
```
## 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 solicitud `PATCH` a `/crm/v3/objects/companies/{companyId}` e incluye los datos que quieras actualizar.
### Nota:
Si actualizas la propiedad `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](https://knowledge.hubspot.com/records/update-a-property-value-for-a-record), o se puede eliminar automáticamente mediante un [workflow](https://knowledge.hubspot.com/records/change-record-lifecycle-stages-in-bulk) 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 solicitud `PUT` a `/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}`.
Para obtener el valor `associationTypeId`, consulta [esta lista](/api-reference/crm-associations-v4/guide#association-type-id-values) de valores predeterminados o haz una solicitud `GET` a `/crm/v4/associations/{fromObjectType}/{toObjectType}/labels`.
Encuentra más información sobre cómo asociar registros a través de la [API de asociaciones](/api-reference/crm-associations-v4/guide).
### Eliminar una asociación
Para eliminar una asociación entre un registro de empresa y un registro o actividad, realiza una solicitud `DELETE` 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 campo `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](/api-reference/overview). 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:
```json theme={null}
///Example request body PATCH /crm/v3/objects/companies/{companyId}
{
"properties": {
"hs_pinned_engagement_id": 123456789
}
}
```
También puedes crear una empresa, asociarla a una actividad existente y fijar la actividad en la misma solicitud. Por ejemplo:
```json theme={null}
///Example request body POST /crm/v3/objects/companies
{
"properties": {
"domain": "example.com",
"name": "Example Company",
"hs_pinned_engagement_id": 123456789
},
"associations": [
{
"to": {
"id": 123456789
},
"types": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 189
}
]
}
]
}
```
## 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](https://knowledge.hubspot.com/records/restore-deleted-records).
Para eliminar una empresa individual por su ID, haz una solicitud `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](/api-reference/crm-companies-v3/guide).