There are use cases where you are required to delete a secondary connection of the integration app, for example, you might have created additional connections with the incorrect store name or created to incorrect store or for testing purposes and not using them anymore.
To resolve such use cases within the integration app, we are supporting the deletion of Secondary connections using integrator.io API tokens.
To delete a secondary connection of the integration app:
- Create an API token. For more information, see Getting started with standard REST API.
- Navigate to the integration app tile you want to delete the connection.
- Click Connections. The Connections page displays a list of connections in the selected integration app.
- In the Actions column of the connection you want to delete, click the three dots.
- Click Used by and check if the connection is being used by other resources or if it’s a primary connection.
IMPORTANT:
- Do not delete the primary connection. The primary connection is created by default during the installation of the integration app, deleting it might impact the functionalities of the integration app and might not work as expected. Assume you have deleted a primary connection unknowingly, use this Restore endpoint explained below to get back the connection.
- The primary connection follows the naming convention as <app name> Connection and this cannot be edited. The naming convention is the one detail with which you can easily identify the primary connection. For example, “<Shopify> Connection”, as shown in the following screenshot. Only for NetSuite connections, the primary connection name has additional details. For example, “<NetSuite> Connection (Shopify Integration App).
- Unlink the connection from all the resources, if you want to delete the connection. Once you unlink the connection, the Used by window displays the following message.
- Delete the connection using DELETE /connections/<_id> endpoint; success code: 204. The API request deletes a disconnected connection in your account. If the connection is used in the integration app or with an external ID or source ID, the API request fails.
Sample request
DELETE /v1/connections/554••••••••••••••••••009
Host: api.integrator.io
Authorization: Bearer my_api_token
Response: Successfully deleted a connection.
{
"code": 204
}
- Restore the connection using POST /recycleBinTTL/connections/<_id> endpoint; success code: 204. The API request restores a deleted connection to your account.
Sample request
POST /v1/recycleBinTTL/connections/554••••••••••••••••••009
Host: api.integrator.io
Authorization: Bearer my_api_token
Response: Successfully restored a connection.
{
"code": 204
}
Comments
0 comments
Please sign in to leave a comment.