Skip to main content

Test Saved Connection

POST 

/api/shippo/instances/:integration_instance/test-connection

Checks the instance's saved API token live against Shippo. A rejected token flags the instance as unhealthy (auth_error_at is set); a successful check clears that flag.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

No body. Returns 200 with connected: true and is_test_mode. Shippo failures return 422 with a stable code: invalid_token (Shippo rejected the API token), rate_limited (Shippo is throttling — retry in a minute), api_error (Shippo refused the request; message carries its reason) or unreachable (Shippo could not be reached). Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Requires the integrations.sync permission.

Request​

Responses​

OK

Response Headers
    Content-Type