Tipo Contato

Abaixo estão especificados os campos que compõem o tipo de contato na API. Este tipo de dado é utilizado para armazenar informações detalhadas sobre contatos associados a uma empresa.

Campos do Contato

Campo
Tipo
Descrição

id

string

Identificador único do contato.

company_id

string

ID da empresa associada ao contato.

name

string

Nome do contato.

phone_number

string

Número de telefone do contato.

email

string

Endereço de email do contato.

address

string

Endereço do contato.

city

string

Cidade do contato.

state

string

Estado do contato.

zip_code

string

Código postal do contato

date_of_birth

Date

Data de nascimento do contato

gender

string

Gênero do contato

profile_picture_url

string

URL da foto de perfil do contato

last_interaction

Date

Data da última interação com o contato

interaction_type

string

Tipo da última interação

notes

string

Notas sobre o contato.

newsletter_subscriber

boolean

Indica se o contato é inscrito em newsletter.

referral_source

string

Fonte de referência do contato.

is_blocked

boolean

Indica se o contato está bloqueado.

social_profiles

object

Perfis sociais do contato

social_profiles.linkedin

string

Perfil do LinkedIn do contato.

social_profiles.facebook

string

Perfil do Facebook do contato.

social_profiles.twitter

string

Perfil do Twitter do contato.

social_profiles.instagram

string

Perfil do Instagram do contato.

social_profiles.threads

string

Perfil do Threads do contato.

custom_fields

array

Campos personalizados do contato (opcional).

custom_fields.key

string

Chave do campo personalizado.

custom_fields.value

string

Valor do campo personalizado.

tags

array

Tags associadas ao contato.

tags.id

string

Identificador único da tag.

tags.name

string

Nome da tag.

tags.color

string

Cor da tag.

Exemplo de JSON

{
  "id": "string",
  "company_id": "string",
  "name": "string",
  "phone_number": "string",
  "email": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "zip_code": "string",
  "date_of_birth": "2023-06-28T12:00:00Z",
  "gender": "string",
  "profile_picture_url": "string",
  "last_interaction": "2023-06-28T12:00:00Z",
  "interaction_type": "string",
  "notes": "string",
  "newsletter_subscriber": true,
  "referral_source": "string",
  "is_blocked": true,
  "social_profiles": {
    "linkedin": "string",
    "facebook": "string",
    "twitter": "string",
    "instagram": "string",
    "threads": "string"
  },
  "custom_fields": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string"
    }
  ]
}

Esta documentação fornece uma visão geral dos campos que compõem o tipo de contato e serve como referência para entender a estrutura de dados utilizada na API para representar contatos.

Last updated

Was this helpful?