Validate Connection
POST/api/faire/instances/:integrationInstance/validate-connection
Verify this integration's stored access token against Faire and capture the brand it belongs to.
Calls Faire to confirm the token is live and reads the brand name/id, which is stored on the integration. Use it to re-check a connection's health or to populate the brand before grouping two integrations that share one Faire account.
Path Parameters:
integrationInstance(required) — the integration to verify
Auth: Requires Bearer token.
Errors:
422— the token could not be verified with Faire (missing, revoked, or unreachable)
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
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.