Updated: 14 December 2023

Cadastrar/atualizar cliente [Client/Sync]

ENDPOINT /v1/Client/Sync
METHOD POST
PARAMETERS TYPE DEMANDED NOTES
WalletId
int Obrigatório
WalletCode string Opcional Poder ser enviado walletCode ou WalletId, codigo externo da carteira
ClientId
int Opcional Deve ser informado para atualizar um cliente.
Em seu lugar pode ser informado o "ExternalId" - vide mais abaixo.
DocumentNumber
string Obrigatório

Name
string Obrigatório


Phone
string Obrigatório  ddi + ddd + phone
Email
string Obrigatório


StartDate
date Opcional mm-dd-yyyy
EndDate
date Opcional mm-dd-yyyy
Variables
json Opcional

ExternalId
string
Opcional

 pode ser obrigatório, caso definido na carteira para exigir este parâmetro.

Se informado e não houver ClientId, será usado para tentar atualizar um cliente já existente.


RETURN TYPE DEMANDED NOTES
success bool

message string







SEND - EXAMPLE

{  
  "walletId" : 1,
  "clientId" : null,
  "documentNumber" : "123456789", 
  "name" : "John Doe", 
  "phone" : "5511999888777",
  "email":"email@domain.com",
  "startDate": "01-30-2022",
  "endDate":"01-30-2023", 
  "variables": { "parameter1":"value", "parameter2":1 },
  "ExternalId":"00001"
}


RECEIVE EXAMPLE

{
    "success": true,
    "message": "ok",
    "clientId": 1
}


RECEIVE EXAMPLE

{
    "success": false,
    "message": "WalletId é obrigatório"
}



Esta tendo algum problema?

CLIQUE AQUI ou então entre em contato com o GUGA - Suporte