Negócios

No HubSpot, os negócios representam transações com contatos ou empresas. Os negócios são rastreados durante o processo de vendas nas fases do pipeline até serem conquistados ou perdidos. Os endpoints de negócios permitem controlar a criação e o gerenciamento de registros de negócios, bem como sincronizar dados de negócios entre o HubSpot e outros sistemas. 

Saiba mais sobre objetos, registros, propriedades e APIs de associações no guia Noções básicas do CRM. Para obter informações mais gerais sobre objetos e registros no HubSpot, saiba como gerenciar seu banco de dados do CRM.

Criar negócios

Para criar novos negócios, faça uma solicitação POST para /crm/v3/objects/deals.

Na solicitação, inclua os dados do negócio em um objeto de propriedades. Você também pode adicionar um objeto de associações para associar seu novo negócio a registros (por exemplo, contatos, empresas) ou atividades (por exemplo, reuniões, observações) existentes.

Propriedades

Os detalhes do negócio são armazenados nas propriedades do negócio. Existem propriedades de negócio padrão do HubSpot, mas você também pode criar propriedades personalizadas.

Ao criar um novo negócio, você deve incluir as seguintes propriedades na solicitação: dealname, dealstage e, caso tenha vários pipelines, pipeline. Se um pipeline não for especificado, o pipeline padrão será usado. 

Para exibir todas as propriedades disponíveis, você pode recuperar uma lista das propriedades de negócios da sua conta, fazendo uma solicitação GET para /crm/v3/properties/deals. Saiba mais sobre a API de propriedades.

Observação: você deve usar o ID interno de uma fase ou pipeline de negócios ao criar um negócio por meio da API. O ID interno também será retornado quando você recuperar negócios por meio da API. Você pode encontrar o ID interno de uma fase ou pipeline de negócios em nas configurações do pipeline de negócios.

Por exemplo, para criar um novo negócio, a solicitação pode ser semelhante à seguinte:

///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" } }

Associações

Ao criar um novo negócio, você também pode associá-lo a registros ou atividades existentes. No objeto de associações, inclua os seguintes campos:

Use this table to describe parameters / fields
ParameterDescription
toObjectId

O ID do registro ou da atividade com o qual você deseja associar o negócio.

associationTypeId

Um identificador exclusivo para indicar o tipo de associação entre o negócio e o outro objeto ou atividade. Os tipos de associação padrão estão listados aqui, ou você pode recuperar o valor fazendo uma solicitação GET para /crm/v4/associations/{fromObjectType}/{toObjectType}/labels. Saiba mais sobre a API de associações.

Você também pode incluir o campo label para atribuir um rótulo de associação definido que descreve a associação. Saiba mais sobre como associar registros por meio da API de associações.

Por exemplo, para associar um novo negócio a um contato e uma empresa existentes, a solicitação seria parecida com a seguinte:

///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 negócios

Você pode recuperar negócios individualmente ou em lotes.

  • Para recuperar um negócio individual, faça uma solicitação GET para /crm/v3/objects/deals/{dealId}.
  • Para solicitar uma lista de todos os negócios, faça uma solicitação GET para /crm/v3/objects/deals.
Para ambos os endpoints, você pode incluir os seguintes parâmetros de consulta no URL da solicitação:
Use this table to describe parameters / fields
ParameterDescription
propriedades
Uma lista separada por vírgulas das propriedades a serem retornadas em resposta. Se o negócio solicitado não tiver um valor para uma propriedade, ele não será exibido na resposta.
propertiesWithHistory

Uma lista separada por vírgulas das propriedades atuais e do histórico a serem retornadas em resposta. Se o negócio solicitado não tiver um valor para uma propriedade, ele não será exibido na resposta.

associações

Uma lista separada por vírgulas de objetos para recuperar IDs associados. Todas as associações especificadas que não existem não serão retornadas na resposta. Saiba mais sobre a API de associações.

Para o endpoint de leitura em lote, você também pode usar o parâmetro idProperty opcional para recuperar negócios por uma propriedade de identificador exclusivo personalizada. Por padrão, os valores de id na solicitação referem-se ao ID do registro (hs_object_id); portanto, o parâmetro idProperty não é necessário ao recuperar pelo ID do registro. Para usar uma propriedade de valor exclusivo personalizada para recuperar negócios, você deve incluir o parâmetro idProperty.

Por exemplo, para recuperar um lote de negócios, sua solicitação pode ser parecida com o seguinte:

///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 negócios com valores atuais e do histórico de uma propriedade, sua solicitação pode ser parecida com o seguinte:

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "dealstage" ], "inputs": [ { "id": "7891023" }, { "id": "987654" } ] }

Atualizar negócios

Você pode atualizar negócios individualmente ou em massa. Para negócios existentes, o ID do negócio é um valor exclusivo que você pode usar para atualizar o negócio por meio da API.

Para atualizar um negócio individual por seu ID de negócio, faça uma solicitação  PATCH para /crm/v3/objects/deals/{dealId} e inclua os dados que deseja atualizar.

Associar negócios existentes a registros ou atividades

Para associar um negócio a outros registros do CRM ou uma atividade, faça uma solicitação PUT para  /crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

Para recuperar o valor associationTypeId, consulte esta lista de valores padrão ou faça uma solicitação GET para /crm/v4/associations/{fromObjectType}/{toObjectType}/labels.

Saiba mais sobre como associar registros com a API de associações.

Remover uma associação

Para remover uma associação entre um negócio e um registro ou uma atividade, faça uma solicitação DELETE para o seguinte URL: /crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Fixar uma atividade em um registro de negócio

Você pode fixar uma atividade em um registro de negócio por meio da API, incluindo o campo hs_pinned_engagement_id na sua solicitação. No campo, inclua o id da atividade a ser fixada, que pode ser recuperado por meio das APIs de engajamentos. Você pode fixar uma atividade por registro. No entanto, a atividade já deve estar associada ao negócio antes da fixação.

Para definir ou atualizar a atividade fixada de um negócio, sua solicitação pode ser parecida com o seguinte:

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

Você também pode criar um negócio, associá-lo a uma atividade existente e fixar a atividade na mesma solicitação. Por exemplo:

///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 }] }] }

Excluir negócios

Você pode excluir negócios individualmente ou em massa, o que adicionará o negócio à lixeira no HubSpot. Posteriormente, você pode restaurar o negócio no HubSpot.

Para excluir um negócio individual pelo seu ID, faça uma solicitação DELETE para /crm/v3/objects/deals/{dealId}.

Saiba mais sobre a exclusão em massa de negócios na guia Endpoints na parte superior deste artigo.


Este artigo foi útil?
Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot..