Sign in

Update customers in batch

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

Updates many customers in one call — a list of items, each with its id and the fields to change. Use it instead of looping the single update: setting the same field on hundreds of customers (e.g. entityType=legal) or importing per-customer values all go in one request.

Each item reuses the exact same path as the single update (same sanitization and validation; only id is required per item, anything omitted is left untouched). A bad item does not fail the batch: the response reports an outcome per item — updated, not_found, or rejected (with the reason) — plus a summary of counts.

Pass dryRun: true to validate without writing: every eligible item comes back as would_update and nothing is changed. Up to 100 items per call.

Try-it values populated from environment ACME (Demo)


Authentication

Token

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

Headers

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.

Request body

Content-Type: application/json

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

Responses

{
  "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