API GTFgts

Cria um novo lead

post

Cadastra um novo lead no sistema

Autorizações

jwtAuth

Corpo

application/json

namestring · máx: 100Obrigatório

Nome completo do lead

Example: João da Silva Santos

identificationstring · máx: 11Obrigatório

CPF do lead

Example: 12345678901

phonestring · máx: 11Obrigatório

Telefone do lead

Example: 11987654321

birthDatestring · dateOpcional

Data de nascimento do lead

Example: 1990-05-15

emailstring · email · máx: 100Opcional

Email do lead

Example: [email protected]

Respostas

201

Lead criado com sucesso

application/json

400

Dados inválidos para criação do lead

application/json

401

Não autorizado

500

Erro interno do servidor

post

HTTPcURLJavaScriptPython

POST /api/leads HTTP/1.1
Host: gtfgts.staging.giro.tech
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "name": "João da Silva Santos",
  "identification": "12345678901",
  "phone": "11987654321",
  "birthDate": "1990-05-15",
  "email": "[email protected]",
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01234-567"
  },
  "pix": {
    "key": "[email protected]",
    "keyType": "EMAIL"
  }
}

{
  "publicId": "abc123def456",
  "url": "https://gtfgts.giro.tech/abc123def456"
}