Un negocio almacena datos sobre una transacción en curso. Los endpoint de negocios te permiten administrar estos datos y sincronizarlos entre HubSpot y otros sistemas.
POST
a /crm/v3/objects/deals
.
En el cuerpo de la solicitud, incluye los datos de tu negocio en un objeto properties
. También puedes agregar un objeto associations
para vincular el nuevo negocio con registros existentes (por ejemplo, contactos o empresas) o actividades (por ejemplo, reuniones o notas).
dealname
, dealstage
y si tienes varias pipelines, pipeline
. Si no se especifica una pipeline, se utilizará la pipeline predeterminada.
Para ver todas las propiedades disponibles, puedes obtener una lista de las propiedades de negocios de tu cuenta haciendo una solicitud GET
a /crm/v3/properties/deals
. Encuentra más información sobre la API de propiedades.
associations
. Por ejemplo, para asociar un nuevo negocio con un registro de contacto y de empresa existentes, la solicitud debería hacerse de la siguiente manera:
associations
, debes incluir lo siguiente:
Parámetro | Descripción |
---|---|
to | El registro o actividad que quieres asociar con el negocio, especificado por su valor id único. |
types | El tipo de asociación entre el negocio y el registro o actividad. Incluye associationCategory y associationTypeId . Los ID de los tipos de asociación predeterminados se enumeran en este recurso, y también 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/deals/{dealId}
.GET
a /crm/v3/objects/deals
.Parámetro | Descripción |
---|---|
properties | Una lista separada con 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 con comas de las propiedades actuales y anteriores que se devolverán en la respuesta. Si el negocio solicitado no tiene un valor para una propiedad, este no aparecerá en la respuesta. |
associations | Una lista separada con comas de los objetos para los que se deben obtener los 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/deals/batch/read
.
idProperty
en el cuerpo de la solicitud para especificar el nombre de la propiedad. Luego, en la matriz inputs
, incluye los valores de la propiedad del identificador único en lugar del ID del negocio.propertiesWithHistory
en el cuerpo de la solicitud, como se muestra a continuación.
PATCH
a /crm/v3/objects/deals/{dealId}
e incluye los datos que quieres actualizar.POST
a /crm/v3/objects/deals/batch/update
. En el cuerpo de la solicitud, incluye una matriz con los identificadores de los negocios y las propiedades que quieres actualizar.PUT
a /crm/v3/objects/deals/{dealId}/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/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
hs_pinned_engagement_id
en tu solicitud. En el valor del parámetro, incluye el id de la actividad a anclar, que se puede obtener 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 cambiar la actividad anclada de un negocio, la solicitud podría hacerse de la siguiente manera:
DELETE
a /crm/v3/objects/deals/{dealId}
. No se necesita un cuerpo de solicitud para esta petición.POST
a /crm/v3/objects/deals/batch/archive
. En el cuerpo de la solicitud, incluye los valores del ID del negocio como entradas de id
, como se muestra en el ejemplo a continuación.