Test Saved Connection
GET/api/shipbob/:instance/test-connection
Re-validate the stored credentials for an existing instance and list the channels available to the token. Never returns an error status for bad credentials.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
When ShipBob accepts the credentials and the connection had been flagged inactive (after a rejected token), the connection is marked active again, automatic sync is re-enabled and the admins' "authorization expired" alert is resolved. Saving a new connection_settings.api_token through Update Integration Instance does the same once ShipBob accepts the new token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.