< Voltar para as definições do objeto principal [talk].
Definição dos campos do objeto "customer":
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do cliente; |
| name string | NÃO | Nome do cliente; |
| external_id string | SIM | Identificador externo do cliente; |
| document_number string | SIM | Número do documento do cliente; |
| wildcard_01 string | SIM | CAMPO DEPRECIADO |
| wildcard_02 string | SIM | CAMPO DEPRECIADO |
| wildcard_03 string | SIM | CAMPO DEPRECIADO |
| wildcard_04 string | SIM | CAMPO DEPRECIADO |
| wildcard_05 string | SIM | CAMPO DEPRECIADO |
| wildcard_06 string | SIM | CAMPO DEPRECIADO |
| wildcard_07 string | SIM | CAMPO DEPRECIADO |
| wildcard_08 string | SIM | CAMPO DEPRECIADO |
| wildcard_09 string | SIM | CAMPO DEPRECIADO |
| wildcard_10 string | SIM | CAMPO DEPRECIADO |
| created_at datetime | NÃO | Data/hora da criação do cliente; |
| main_sms int | SIM | Identificador interno do número de SMS prioritário; |
| main_whatsapp int | SIM | Identificador interno do número de WhatsApp prioritário; |
| main_email int | SIM | Identificador interno do endereço de e-mail prioritário; |
| agent_id int | SIM | Identificador interno do agente ao qual o cliente está fidelizado; |
| queue_id int | SIM | Identificador interno da fila de atendimento à qual o cliente está fidelizado; |
| profile_picture_url string | SIM | CAMPO DEPRECIADO |
| is_priority bool | NÃO | Flag para identificar se o cliente é prioritário ou não; |
| last_base_api string | SIM | Identificador da base da integração do cliente no último atendimento iniciado; OBS: Esta informação está disponível apenas para contas que possuem integração com ERP's com a funcionalidade de multi-bases; |
| customer_organization_id int | SIM | Identificador interno da organização à qual o cliente pertence; |
| crmv_user_id int | SIM | CAMPO DEPRECIADO |
| crmv_person_id int | SIM | CAMPO DEPRECIADO |
| is_active bool | NÃO | CAMPO DEPRECIADO |
| cxm_user_id int | SIM | CAMPO DEPRECIADO |
| profile_info <Object profileInfo> | SIM | Dados do perfil do cliente; |
| custom_fields list <Object customerCustomField> | SIM | Lista de campos customizados; |
| telephones list <Object customerTelephone> | SIM | Lista de telefones do cliente; |
| emails list <Object customerEmail> | SIM | Lista de e-mails do cliente; |
Exemplo de payload
{
"id": 144527,
"name": "JONAS",
"external_id": "95238935",
"document_number": "",
"wildcard_01": "",
"wildcard_02": "",
"wildcard_03": "",
"wildcard_04": "",
"wildcard_05": "",
"wildcard_06": "",
"wildcard_07": "",
"wildcard_08": "",
"wildcard_09": "",
"wildcard_10": "",
"created_at": "2023-09-21T12: 28: 45.000000Z",
"main_sms": 44290,
"main_whatsapp": 44290,
"main_email": 25396,
"agent_id": null,
"queue_id": null,
"customer_group_id": null,
"profile_picture_url": null,
"is_priority": false,
"last_base_api": null,
"customer_organization_id": 15662,
"crmv_user_id": 65886,
"crmv_person_id": 9523893,
"is_active": true,
"cxm_user_id": null,
"profile_info": {
"name": "Jonas Schen",
"username": "j.schen",
"profile_pic": "https: //scontent-gru1-2.cdninstagram.com/v/t51.2885-19/136402463_253976186149719_5865312005602673050_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=1-7&_nc_sid=bf7eb4&_nc_eui2=AeHYN5VZiIc-sNtHGCgs4254feyGsovGEtd97Iayi8YS108vxDsrXCu3TL9YLx0Gt0ajlYNuFFeStw7XimoOCt8c&_nc_ohc=ZvuS5PnxbuIQ7kNvwEFvYu8&_nc_oc=Adkmlu7T1RN2lcleakngSeC_fbAhYLw5m6KANJ33KMsM1KnrjaOstylyzRgEtOt1fcc&_nc_zt=24&_nc_ht=scontent-gru1-2.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AfSiRcadzk9IDd3dKCgN1WnE9_6TvlAdGfsDeZrsdNBMrw&oe=687F1E0E",
"is_verified_user": false,
"follower_count": 219,
"is_user_follow_business": true,
"is_business_follow_user": false,
"id": "8215422678527800"
},
"custom_fields": {
"Empresa": "Piperun",
"Web Whatsapp - Pessoa": "(51) 99999-8888",
"Nacionalidade": "Brasileira"
},
"telephones": [
{
"id": 70994,
"customer_id": 144527,
"area_code": "51",
"number": "999887766",
"type": "m",
"level_id": "N",
"has_sms": false,
"has_whatsapp": false,
"has_whatsapp_api": false,
"wa_is_business": false,
"wa_is_enterprise": false,
"wa_contact_name": null,
"wa_pushname": null,
"wa_verified_level": null,
"wa_verified_name": null,
"wa_profile_picture": null,
"session_expires_at": null,
"insert_origin": "MAILING",
"inserted_by": 127,
"country_code": "55",
"country_iso2": "br",
"full_number": "51999887766",
"full_number_cc": "+55 51999887766"
}
],
"emails": [
{
"id": 49543,
"customer_id": 144527,
"email": "[email protected]",
"level_id": "N",
"insert_origin": "AUTO",
"inserted_by": 2,
"unsubscribed_at": null
}
]
}