Documentação da API

POST /update_contact

Resumo

Este endpoint permite atualizar os dados de um contato existente em uma unidade específica.

---

Descrição

Utilize este endpoint para modificar informações de um contato, como tipo, CPF/CNPJ, nome, endereço, e outros detalhes. O contato deve existir e estar associado à unidade informada.

---

Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token identificador da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
token	string	Sim	Token identificador do contato a ser atualizado.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
type	string	Não	Tipo de contato (legal ou natural_person).	natural_person
register	string	Não	CPF (pessoa física) ou CNPJ (pessoa jurídica).	12345678909 ou 12345678000195
fullName	string	Não	Nome completo do contato (para natural_person).	João Silva
fantasyName	string	Não	Nome fantasia (para legal).	Empresa XYZ
socialReason	string	Não	Razão social (para legal).	XYZ Comércio Ltda
birthDate	string	Não	Data de nascimento (formato DD/MM/YYYY).	15/05/1990
phone	string	Não	Número de telefone.	11987654321
email	string	Não	Endereço de e-mail.	joao.silva@email.com
address	string	Não	Endereço completo.	Rua Exemplo, 123
zip_code	string	Não	CEP (apenas números).	12345678
state	string	Não	Estado (sigla).	SP
city	string	Não	Cidade.	São Paulo
neighborhood	string	Não	Bairro.	Centro
observation	string	Não	Observações sobre o contato.	Cliente estratégico
data_bank	string	Não	Dados bancários do contato.	Banco: 001, Ag: 1234, Conta: 56789-0
number	string	Não	Número do endereço.	123
complement	string	Não	Complemento do endereço.	Apto 45

---

Exemplo de Requisição

Curl (Atualização de Pessoa Física)

curl -X POST 'https://portal.fipli.pro/api/v1/update_contact' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "token": "<token>",
  "type": "natural_person",
  "fullName": "<fullName>",
  "phone": "<phone>",
  "email": "<email>",
  "address": "<address>",
  "zip_code": "<zip_code>",
  "state": "<state>",
  "city": "<city>",
  "neighborhood": "<neighborhood>",
  "observation": "<observation>",
  "data_bank": "<data_bank>",
  "number": "<number>",
  "complement": "<complement>"
}'

Curl (Atualização de Pessoa Jurídica)

curl -X POST 'https://portal.fipli.pro/api/v1/update_contact' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "token": "<unit_token>",
  "type": "legal",
  "register": "<register>",
  "fantasyName": "<fantasyName>",
  "socialReason": "<socialReason>",
  "phone": "<phone>>",
  "email": "<email>",
  "address": "<address>",
  "zip_code": "<zip_code>",
  "state": "<state>",
  "city": "<city>",
  "neighborhood": "<neighborhood>",
  "observation": "<observation>",
  "data_bank": "<data_bank>",
  "number": "<number>",
  "complement": "<complement>"
}'

---

Resposta

200 OK

Atualização realizada com sucesso.

{
  "success": true,
  "message": "Contact updated successfully",
  "token": "a6927665-6d56-4839-ad23-37d48717da13"
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing required parameters."	Algum parâmetro obrigatório (access_token, unit_token, token) não foi enviado.
400	"Invalid CPF."	O CPF fornecido é inválido (quando type: natural_person).
400	"Invalid CNPJ."	O CNPJ fornecido é inválido (quando type: legal).
400	"No fields provided to update."	Nenhum campo válido foi fornecido para atualização.
403	"Invalid authentication data."	Token de autenticação inválido ou não autorizado.
404	"Unit not found."	A unidade com o unit_token fornecido não foi encontrada.
404	"Contact not found or not updated."	O contato com o token fornecido não foi encontrado ou não foi atualizado.
500	"An unexpected error occurred. Please try again later."	Erro interno no servidor.

---

Observações

• Pelo menos um dos campos opcionais (type, register, fullName, fantasyName, socialReason, birthDate, phone, email, address, zip_code, state, city, neighborhood, observation, data_bank, number, complement) deve ser fornecido para realizar a atualização.
• O campo register deve ser um CPF válido para natural_person ou um CNPJ válido para legal, caso seja fornecido. A validação é feita após a remoção de caracteres não numéricos.
• O campo birthDate deve estar no formato DD/MM/YYYY e será convertido para YYYY-MM-DD para armazenamento.
• Os campos phone e zip_code têm caracteres não numéricos removidos antes do armazenamento.
• A atualização é realizada de forma transacional, garantindo a consistência dos dados no banco.
• Certifique-se de que os tokens estejam válidos e que a unidade e o contato existam no sistema.