Negocios

En HubSpot, los negocios representan transacciones con contactos o empresas. A los negocios se les hace seguimiento través de tu proceso de venta en las etapas de la pipeline hasta que se ganan o se pierden. Los puntos de terminación de los negocios te permiten crear y administrar negocios, así como sincronizar los datos de los negocios 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 negocios

Para crear nuevos negocios, haz una solicitud POST en /crm/v3/objects/deals.

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

Propiedades

Los detalles del negocio se almacenan en las propiedades de negocio. Hay propiedades de negocio de HubSpot predeterminadas, pero también puedes crear propiedades personalizadas.

Al crear un nuevo negocio, debes incluir las siguientes propiedades en tu solicitud: dealname, dealstage y, si tiene varias pipelines, pipeline. Si no se especifica una pipeline, se utilizará la pipeline predeterminada. 

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

Nota: debes usar el ID interno de una etapa o pipeline de negocio al crear un negocio a través de la API. El ID interno también se devolverá cuando recuperes negocios a través de la API. Puedes encontrar el ID interno de una etapa de negocio o pipeline en la configuración de tu pipeline de negocios.

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

///Example request body { "properties": { "amount": "1500.00", "closedate": "2019-12-07T16:50:06.678Z", "dealname": "New deal", "pipeline": "default", "dealstage": "contractsent", "hubspot_owner_id": "910901" } }

Asociaciones

Al crear un nuevo negocio, 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 negocio.

associationTypeId

Un identificador único para indicar el tipo de asociación entre el negocio 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 negocio con un registro de contacto y de empresa existentes, tu solicitud se vería de la siguiente manera:

///Example request body { "properties": { "amount": "1500.00", "closedate": "2019-12-07T16:50:06.678Z", "dealname": "New deal", "pipeline": "default", "dealstage": "contractsent", "hubspot_owner_id": "910901" }, "associations": [ { "to": { "id": 201 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 5 } ] }, { "to": { "id": 301 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 3 } ] }] }

Recuperar negocios

Puedes recuperar negocios individualmente o en lotes.

  • Para recuperar un negocio individual, haz una solicitud GET en /crm/v3/objects/deals/{dealId}.
  • Para recuperar una lista de negocios, haz una solicitud GET en /crm/v3/objects/deals.
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 negocio solicitado no tiene un valor para una propiedad, este 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 negocio solicitado no tiene un valor para una propiedad, este 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 ofertas específicas por ID de registro o una propiedad de identificador único personalizado, realice una solicitud POST a crm/v3/objects/deals/batch/read. El punto de terminación por lote no puede recuperar asociaciones. Obtener 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 negocios mediante una propiedad de identificador único personalizada. 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 negocios, debes incluir el parámetro idProperty.

Por ejemplo, para recuperar un lote de negocios, tu solicitud podría tener uno de los siguientes aspectos:

///Example request body with record ID { "properties": [ "dealname", "dealstage", "pipeline" ], "inputs": [ { "id": "7891023" }, { "id": "987654" } ] }
///Example request body with a unique value property { "properties": [ "dealname", "dealstage", "pipeline" ], "idProperty": "uniqueordernumber", "inputs": [ { "id": "0001111" }, { "id": "0001112" } ] }

Para recuperar negocios 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": [ "dealstage" ], "inputs": [ { "id": "7891023" }, { "id": "987654" } ] }

Actualizar negocios

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

Para actualizar un negocio individual mediante el ID del negocio, haz una solicitud PATCH en /crm/v3/objects/deals/{dealId}, e incluye los datos que deseas actualizar.

Asociar negocios existentes con registros o actividades

Para asociar un negocio con otros registros del CRM o con una actividad, haz una solicitud PUT en  /crm/v3/objects/deals/{dealId}/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 negocio y un registro o actividad, haz una solicitud DELETE en la siguiente URL: /crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Anclar una actividad en el registro de un negocio

Puedes anclar una actividad en el registro de un negocio a través de la API incluyendo el campo hs_pinned_engagement_id en tu solicitud. En el campo, incluye el id de la actividad a anclar, que se puede recuperar a través de las API de interacciones. Puedes anclar una actividad por registro, y la actividad ya debe estar asociada con el negocio antes de anclarla.

Para establecer o actualizar la actividad anclada de un negocio, tu solicitud podría ser la siguiente:

///Example request body PATCH /crm/v3/objects/deals/{dealId} { "properties": { "hs_pinned_engagement_id": 123456789 } }

También puedes crear un negocio, asociarlo a una actividad existente y anclar la actividad en la misma solicitud. Por ejemplo:

///Example request body POST /crm/v3/objects/deals { "properties": { "dealname": "New deal", "pipelines": "default", "dealstage": "contractsent", "hs_pinned_engagement_id": 123456789 }, "associations": [ { "to": { "id": 123456789 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 213 }] }] }

Eliminar negocios

Puedes eliminar negocios individualmente o por lotes, lo que agregará el negocio a la papelera de reciclaje en HubSpot. Más adelante puedes restaurar el negocio dentro de HubSpot.

Para eliminar un negocio individual por su ID, haz una solicitud DELETE en /crm/v3/objects/deals/{dealId}.

Obtén más información sobre la eliminación de negocios 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.