Registros da empresa armazenam dados sobre os negócios. Os pontos de extremidade das empresas permitem que você gerencie e sincronize esses dados entre o HubSpot e outros sistemas.
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.
name
ou domain
. É recomendável incluir sempre o domain
, 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.
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.Descrição | Parâmetro |
---|---|
to | O registro ou a atividade que você deseja associar à empresa especificado por seu valor de id exclusivo. |
types | O tipo de associação entre a empresa e o registro/atividade. Inclua associationCategory e associationTypeId . Os IDs de tipo de associação padrão são listados aqui, ou você pode recuperar o valor de tipos de associação personalizados (ou seja, rótulos) por meio da API de associações. |
GET
para /crm/v3/objects/companies/{companyId}
.GET
para /crm/v3/objects/companies
.Descrição | Parâmetro |
---|---|
properties | 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. |
associations | 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. |
POST
para crm/v3/objects/companies/batch/read
. O ponto de extremidade em lote não pode recuperar associações. Saiba como fazer associações de leitura em lote com a API de associações.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:
Para recuperar empresas com valores atuais e do histórico de uma propriedade, sua solicitação pode ser parecida com o seguinte:
PATCH
para /crm/v3/objects/companies/{companyId}
e inclua os dados que deseja atualizar.
lifecyclestage
, você só pode definir o valor avançar na ordem do estágio. Para definir o estágio do ciclo de vida para trás, primeiro você precisa limpar o valor do estágio do ciclo de vida existente do registro. O valor pode ser apagado manualmente ou automaticamente por meio de um fluxo de trabalho ou de uma integração que sincroniza os dados do contato.PUT
para /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
associationTypeId
, consulte esta lista de valores padrão ou envie uma solicitação GET
para /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.DELETE
para o seguinte URL: /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
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 à empresa antes da fixação.
Para definir ou atualizar a atividade fixada de uma empresa, sua solicitação pode ser parecida com o seguinte:
DELETE
para /crm/v3/objects/companies/{companyId}
.
Saiba mais sobre empresas de exclusão em lote na documentação de referência.