API do CRM | Propriedades

​

Propriedades padrão

• Contatos
• Empresas
• Negócios
• Tickets
• Atividades (Chamadas, e-mails, reuniões, notas, tarefas)
• Leads(Sales Hub Professional e Enterprise)

​

Grupos de propriedades

​

Tipo de propriedade e valores fieldType

​

Criar uma propriedade

• groupName: o grupo de propriedades em que a propriedade estará inserida.
• name: o nome interno da propriedade (por exemplo, favorite_food).
• label: o nome da propriedade tal como aparece no HubSpot (por exemplo, Favorite Food).
• type: o tipo de propriedade.
• fieldType: o tipo de campo da propriedade.

{
"groupName": "contactinformation",
"name": "favorite_food",
"label": "Favorite Food",
"type": "string",
"fieldType": "text"
}

​

Criar propriedades de identificador exclusivo

• Faça uma solicitação POST para /crm/v3/properties/{objectType}.
• No corpo da solicitação, para o campo hasUniqueValue, defina o valor como true.

{
"groupName": "dealinformation",
"name": "system_a_unique",
"label": "Unique ID for System A",
"hasUniqueValue": true,
"type": "string",
"fieldType": "text"
}

​

Criar propriedades de cálculo

​

Sintaxe da propriedade de cálculo

​

Sintaxe literal

• Literal de string: strings constantes podem ser representadas com aspas simples ('constant') ou aspas duplas ("constant").
• Literal de número: os números constantes podem ser quaisquer números reais e podem incluir notação de pontos. 1005 e 1.5589 são números de constante válidos.
• Literal de booleano: booleanos de constantes podem ser true ou false.

​

Sintaxe de propriedade

• Variáveis de propriedade de string: para uma string de identificador ser interpretada como uma propriedade de string, ela deve ser vinculada à função string. Por exemplo, string(var1) será interpretada como o valor var1 da propriedade de string.
• Variáveis de propriedade numérica: todos os identificadores serão interpretados como variáveis de propriedade numérica. Por exemplo, var1 será interpretado como o valor var1 da propriedade numérica.
• Variáveis de propriedade booleana: para um identificador ser interpretado como uma propriedade bool, ele deve ser vinculado à função bool. Por exemplo, o identificador bool(var1) será interpretado como o valor var1 da propriedade booleana.

​

Operadores

​

Funções

• number_to_string: tenta converter a expressão do número de entrada em uma string.
• string_to_number: tenta converter a expressão da string de entrada em um número.

​

Declarações condicionais

​

Exemplos de fórmulas

"calculationFormula": "closed - started"

"calculationFormula": "if is_present(hs_latest_sequence_enrolled_date) then
  if is_present(hs_sequences_actively_enrolled_count) an hs_sequences_actively_enrolled_count >= 1 then
    true
  else
    false
else
  ''"

​

Recuperar propriedades

• Para recuperar uma propriedade individual, faça uma solicitação GET para crm/v3/properties/{object}/{propertyName}. Por exemplo, para recuperar a propriedade favorite_food, seu URL de solicitação seria /crm/v3/properties/contacts/favorite_food.
• Para obter todas as propriedades de um objeto, faça uma solicitação GET para /crm/v3/properties/{objectType}.

​

Atualizar ou limpar o valor de uma propriedade

​

Adicionar valores às propriedades data e hora

• Strings com formatação ISO 8601: dependendo do tipo de dados, elas terão um destes dois formatos:
  • Para valores que representam uma data específica, o formato de data completo será usado: YYYY-MM-DD (por exemplo, 2020-02-29)
  • Para valores que representam uma data e hora específicas, será usado o formato de data completa mais horas, minutos, segundos e uma fração decimal de segundo: AAAA-MM-DDThh:mm:ss.sTZD (por exemplo 2020-02-29T03:30:17.000Z). Todos os horários serão representados em UTC, então os valores sempre usarão o designador de UTC “Z.”
• Data/hora em formato UNIX em milissegundos: valores de data/hora em milissegundos, que são representados em UTC. Por exemplo, o valor de data/hora 1427997766000 é traduzido como 2 de abril de 2015, 18:02:46 UTC ou 2 Abr 2015, 2:02:46 PM EDT (Horário de Verão do Leste).

• date propriedades armazenam a data, não o tempo. As propriedades date exibem a data em que foram definidas, independentemente da configuração de fuso horário da conta ou do usuário. Para valores de propriedade date, recomenda-se usar o formato de data completo ISO 8601. Se você usar o formato de data/hora UNIX, deverá usar uma data/hora em milissegundos de Era (ou seja, o valor deve ser definido como meia-noite UTC para a data). Por exemplo, para representar 1° de maio de 2015 em qualquer formato:
  • IOS 8601: 2015-05-01
  • UNIX millisecond timestamp: 1430438400000
• datetime As propriedades datetime armazenam a data e a hora. Qualquer formato de data/hora será aceito. No HubSpot, as propriedades datetime são exibidas com base no fuso horário do usuário que vê o registro; portanto, o valor será convertido para o fuso horário local do usuário.

​

Adicionar valores às propriedades de tipo de caixa de seleção

• Propriedade de caixa de seleção Booleano: para ser exibido como Sim ou aparecer como selecionado no HubSpot, seu valor deve ser true. Para ser exibido como Não ou aparecer como não marcado no HubSpot, seu valor deve ser false.
• Propriedade de várias caixas de seleção: para adicionar ou anexar valores a uma propriedade de várias caixas de seleção, adicione um ponto e vírgula antes do primeiro valor e inclua um ponto e vírgula entre cada valor. Se a propriedade tiver um valor existente, o ponto e vírgula inicial adicionará os valores em vez de sobrescrevê-los. Por exemplo, um contato tem o valor existente DECISION_MAKER para a propriedade hs_buying_role. Para adicionar valores sem substituir o valor existente, sua solicitação seria assim:

{
"properties": {
"hs_buying_role": ";BUDGET_HOLDER;END_USER"
}
}

​

Atribuir proprietários de registos usando propriedades do usuário

​

Limpar um valor de propriedade