Entrar

Atualizar clientes em lote

PUT https://{organization}.myguper.com/api/register/customer/batch

Atualiza vários clientes numa chamada só — uma lista de itens, cada um com seu id e os campos a mudar. Use no lugar de repetir o update único: setar o mesmo campo em centenas de clientes (ex.: entityType=legal) ou importar valores por cliente, tudo numa requisição.

Cada item reusa o mesmo caminho do update único (mesma sanitização e validação; só id é obrigatório por item, o que for omitido fica inalterado). Um item ruim não derruba o lote: a resposta traz um outcome por item — updated, not_found ou rejected (com o motivo) — e um summary com as contagens.

Passe dryRun: true para validar sem gravar: cada item elegível volta como would_update e nada muda. Até 100 itens por chamada.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Corpo da requisição

Content-Type: application/json

{
  "items": [
    { "id": 683752, "entityType": "legal" },
    { "id": 683999, "entityType": "legal" },
    { "id": 684010, "name": "Tintin", "email": "tintim@guper.co" }
  ],
  "dryRun": false
}

Respostas

{
  "dryRun": false,
  "total": 3,
  "summary": { "updated": 2, "notFound": 1, "rejected": 0 },
  "results": [
    { "id": 683752, "outcome": "updated" },
    { "id": 683999, "outcome": "updated" },
    { "id": 684010, "outcome": "not_found" }
  ]
}
Copied to clipboard