Delete Instance
DELETE/api/shipbob/:instance
Disconnect a ShipBob integration instance. Webhook subscriptions are removed at ShipBob and all mirrored data is deleted in the background; the request returns immediately.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Returns 422 (nothing is removed) while ShipBob billing has capitalised receiving fees into purchase orders received in a locked accounting period; data.locked_lines lists them. Unlock the period or keep the integration.
Closed periods: the delete is refused with 422 IntegrationInstanceDeletionBlocked when it would remove any accounting record dated on or before the accounting lock date (for example journal entries built from the connection's payouts). Nothing is removed. data.deletion_impact lists what blocked it. Pause the connection's sync instead, or lower the hard close date first. Get Integration Instance Deletion Impact checks this beforehand.
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.