Associações da v3

There is a new version of the Associations API that adds the ability to create multiple types of associations between two object types.

As associações representam as relações entre objetos e atividades no CRM da HubSpot. Você pode usar os endpoints de associações para criar, recuperar ou remover associações em massa. Você pode associar os seguintes objetos ou envolvimentos por meio da API de associações:

  • Contatos
  • Empresas
  • Negócios
  • Tickets
  • Chamadas
  • Orçamentos
  • Line_items
  • Reuniões
  • Produtos
  • Feedback_submissions
  • Objetos personalizados (o nome do seu objeto)

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.

Please note: this API doesn't support parent-child associations or special contact-to-company associations. Learn more about how you can use these associations with the previous version of the associations API.

Definições de associação

As associações são definidas por objeto e direção. Os tipos de associação são unidirecionais. Isso significa que você precisará usar uma definição diferente dependendo do tipo de objeto inicial. Por exemplo:

  • Para ver todos os tickets associados a um contato, defina a associação com o URL de solicitação /crm/v3/associations/Contacts/Tickets/batch/read e identifique o contato no corpo da solicitação pelo objectId. Neste exemplo, Contatos é o fromObjectType e Tickets é o toObjectType.
  • Para associar um registro do contato a um registro de objeto personalizado, onde seu objeto personalizado é Animais de estimação, defina a associação com o URL de solicitação /crm/v3/associations/Pets/Contacts/batch/create e identifique os registros do contato e do animal de estimação que você deseja associar no corpo da solicitação pelos objectIds. Neste exemplo, Animais de estimação é fromObjectType e Contatos é o toObjectType.

Para exibir todos os tipos de associação definidos entre objetos, faça uma solicitação GET para /crm/v3/associations/{fromObjectType}/{toObjectType}/types.

Criar associações

Para associar registros no HubSpot, faça uma solicitação POST para /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create. Na solicitação, inclua os valores de id para os registros que deseja associar, bem como o type de associação ao qual os registros pertencem.

Por exemplo, para associar contatos a empresas, seu URL de solicitação seria /crm/v3/associations/Contacts/Companies/batch/create e a solicitação seria semelhante à seguinte:

///Example request body { "inputs": [ { "from": { "id": "53628" }, "to": { "id": "12726" }, "type": "contact_to_company" } ] }

Recuperar associações

Para recuperar registros associados, faça uma solicitação POST para /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read. Na solicitação, você pode incluir o id de um registro específico para o fromObjectType. Na sua resposta, você receberá os valores de id de todos os registros associados ao toObjectType.

Por exemplo, para recuperar todos os negócios associados a uma empresa, seu URL de solicitação seria semelhante a /crm/v3/associations/Companies/Deals/batch/read. Sua resposta incluiria os valores de id para todos os negócios associados.

Remover associações

Para remover associações entre registros, faça uma solicitação POST para /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive.


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..