⚠️ Atenção: este é um artigo de caráter técnico.
Antes de começar, recomendamos que você conte com a ajuda de um programador experiente e tenha o seu token de autenticação em mãos (que pode ser encontrado em Menu > Integrações).
A documentação da nossa API está disponível neste link.
Rotas List/Get organizations/people/deals
As rotas GET são para consultar dados. Elas só vão retornar os campos customizados quando um parâmetro ?withCustomFields=true for passado. Os campos customizados serão retornados dentro de um objeto customFields.
Exemplo de response body:
"customFields": {
"quantidade_de_vidas": 14,
"principal_necessidade": "Redução de custo e aumentar abrangência nacional"
}
Rotas Create/Update/Upsert organizations/people/deals
Para inserção/atualização de campos customizados, o formato de payload do request deve ser através de um objeto customFields, no qual a chave deve ser a coluna identificadora de cada campo.
Exemplo de request body:
customFields: { "inscricao_estadual": "388.108.598.269" }
Campos de seleção única ou seleção múltipla
No caso de campos do tipo seleção única ou seleção múltipla, você deve passar o id das opções.
Exemplo:
Dado esse exemplo de retorno da rota GET: https://api.agendor.com.br/v3/custom_fields/organizations
{
"id": 6130,
"identifier": "cartelas",
"name": "Cartelas",
"type": "multiselect",
"options": [
{ "id": 5179, "name": "Opção A" },
{ "id": 5180, "name": "Opção B" }
]
},
{
"id": 7836,
"identifier": "sexo",
"name": "Sexo",
"type": "select",
"options": [
{ "id": 7959, "name": "Masculino" },
{ "id": 7960, "name": "Feminino" }
]
},Para criar uma nova empresa, com a "Opção A" no campo Cartolas e a "Masculino" no campo Sexo, basta enviar:
{
"name": "Empresa com campo customizado",
"customFields": {
"cartelas": [5179],
"sexo": 7959
}
}
Rotas Get /custom_fields
Essas rotas listam os campos disponíveis, para que você consiga saber o identificador que representa cada campo.
List organization custom fields:
GET /custom_fields/organizationsList people custom fields:
GET /custom_fields/peopleList deals custom fields:
GET /custom_fields/deals
Exemplo de response body:
{
"data": [{
"id": 234,
"identifier": "frequencia_de_venda",
"name": "Frequência de venda",
"type": "text",
"section": "basic_data",
"createdAt": "2022-06-13T17:48:52.041Z",
"updatedAt": "2022-06-13T17:48:52.041Z"
}
]}
Dúvidas com relação a esse conteúdo? Procure nossa equipe de Suporte nos canais disponíveis!