Sync customers in bulk
Upsert up to 500 businesses from your book. Each gets an eligibility answer now (UK companies with a company number, when eligibility is switched on for your account) and again when its next check is due. Subscribe to customer.became_eligible to hear when one becomes likely to qualify, instead of guessing who to tell.
An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Up to 500 businesses per call. Upserts by partner_customer_id. Businesses only: no people, no personal numbers.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://sandbox.capvant.com/customers/bulk" \ -H "Content-Type: application/json" \ -d '{ "customers": [ { "partner_customer_id": "string", "country": "GB" } ] }'{ "object": "customer_sync", "received": 0, "created": 0, "updated": 0, "eligibility_enabled": true, "results": [ { "partner_customer_id": "string", "band": "likely" } ]}