Empresas 

No HubSpot, as empresas armazenam informações sobre as organizações que interagem com os seus negócios. Os endpoints de empresas permitem controlar a criação e o gerenciamento de registros de empresas, bem como sincronizar os dados de empresas 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 empresas

Para criar novas empresas, faça uma solicitação POST para /crm/v3/objects/companies.

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

Propriedades

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

Ao criar uma nova empresa, você deve incluir pelo menos uma das seguintes propriedades na solicitação: name ou domain. É recomendável incluir sempre o domínio, pois os nomes de domínio são o principal identificador exclusivo para evitar empresas duplicadas no HubSpot. Se uma empresa tiver vários domínios, você pode adicioná-los por meio da API usando o campo hs_additional_domains, separando cada domínio com ponto e vírgula. Por exemplo: "hs_additional_domains" : "domain.com; domain2.com; domain3.com".

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

Observação: se você tiver incluído lifecyclestage em sua solicitação, os valores devem se referir ao nome interno da fase do ciclo de vida. Os nomes internos das fases padrão são valores de texto e não mudam, mesmo se você editar o rótulo da fase (por exemplo, subscriber ou marketingqualifiedlead). Os nomes internos das fases personalizadas são valores numéricos. Você pode encontrar o ID interno de uma fase nas configurações de fase do ciclo de vida ou recuperando a propriedade de fase do ciclo de vida por meio da API.

Por exemplo, para criar uma nova empresa, a solicitação pode ser semelhante à seguinte:

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

Associações

Ao criar uma nova empresa, você também pode associá-la 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 a qual você deseja associar a empresa.

associationTypeId

Um identificador exclusivo para indicar o tipo de associação entre a empresa 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 uma nova empresa a um contato e um e-mail existentes, a solicitação seria parecida com a seguinte:

///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 empresas

Você pode recuperar empresas individualmente ou em lotes.

  • Para recuperar uma empresa individual, faça uma solicitação GET para /crm/v3/objects/companies/{companyId}.
  • Para solicitar uma lista de todas as empresas, faça uma solicitação GET para /crm/v3/objects/companies.

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 a empresa solicitada não tiver um valor para uma propriedade, ela não será exibida na resposta.

propertiesWithHistory

Uma lista separada por vírgulas das propriedades atuais e do histórico a serem retornadas em resposta. Se a empresa solicitada não tiver um valor para uma propriedade, ela não será exibida 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 ponto de extremidade de leitura em lote, você também pode usar o parâmetro idProperty opcional para recuperar empresas 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 empresas, você deve incluir o parâmetro idProperty.

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

///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 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": [ "name" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }

Atualizar empresas

Você pode atualizar empresas individualmente ou em massa. Para empresas existentes, o ID de registro da empresa é um valor exclusivo que você pode usar para atualizar a empresa por meio da API.

Para atualizar uma empresa individual por seu ID da empresa, faça uma solicitação PATCH para /crm/v3/objects/companies/{companyId} e inclua os dados que deseja atualizar.

Associar empresas existentes a registros e atividades

Para associar uma empresa a outros registros do CRM ou a uma atividade, faça uma solicitação PUT para  /crm/v3/objects/companies/{companyId}/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 uma empresa e um registro ou uma atividade, faça uma solicitação DELETE para o seguinte URL: /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Excluir empresas

Você pode excluir empresas individualmente ou em massa, o que adicionará a empresa à lixeira no HubSpot. Posteriormente, você pode restaurar a empresa no HubSpot.

Para excluir uma empresa individual por seu ID, faça uma solicitação DELETE para /crm/v3/objects/companies/{companyId}.

Saiba mais sobre a exclusão em massa de empresas 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..