Disconnect an integration

DELETE/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}

v1Operation ID v1_public_external_integration_destroy

Disconnects an integration. What happens depends on the type:

• Suppliers and Twilio: removed from YoPrint, with their saved credentials.
• GoShippo: turned off (status: DISABLED) and its shipping methods are deleted. Refused while a shipment package from it is not yet delivered.
• Square and QuickBooks Online: YoPrint revokes its access at the provider, then removes it. A Square connection still waiting for a transfer from another team is removed without revoking.
• Shopify: can't be disconnected here. The call answers 422 shopify_uninstall_from_shopify_required with links in error.shopify_admin_url and error.shopify_admin_settings_apps_url: uninstall the app in the Shopify admin.

Retired integrations can be deleted too; find them with "Search integrations", since the list leaves them out. The answer is 200 with data: null.

Permission

Needs the Manage Settings permission. The team owner always has it.

Side effects

• Square and QuickBooks Online: calls the provider to revoke YoPrint's access.
• Team members who have YoPrint open see the change at once.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• external_integration_referencestringrequired

  The integration, from the integration list. Its hash id from an earlier answer; there is no unique key for it.

  • Example d9ZxWgBz09mDFq

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No integration of your team has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the list.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  error.code has_existing_packages: GoShippo still has packages not yet delivered. Or plan_limitation: the integration is not in your plan.

  Fix

  Wait for the packages to be delivered.

  When

  Shopify: shopify_uninstall_from_shopify_required, with error.shopify_admin_url, error.shopify_admin_app_url and error.shopify_admin_settings_apps_url.

  Fix

  Uninstall the YoPrint app in the store's Shopify admin.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  The delete itself failed: error.code delete_fail.

  Fix

  Read the integration again, then retry.

Related

• GETList integrations/v1/api/store/{team_slug}/setting/external_integration
• POSTConnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/setting/external_integration/d9ZxWgBz09mDFq' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}