Skip to main content

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.

Required scope: integrations:write

Grant 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​

OK

Response Headers
    Content-Type