Sync Square Customers

POST 
/api/square/instances/:squareIntegrationInstance/customers/sync

Fetch and upsert Square customers for a specific instance. Queued.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Route name: square.customers.sync

Requires the integrations.sync permission.

Request

Responses

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.