modify_connection_state
Updates the connection state by pausing, modifying, and unpausing the connection. Supports Function and Connection SDK connectors.
Instructions
⚠️ WRITE OPERATION - Confirm with user before calling. Updates the connection state. To update the state, you should pause your connection first. To update the connection state, do the following: 1. Pause connection using Update a Connection endpoint (set 'paused' to 'true'). 2. Update the state by using the Update Connection State endpoint. 3. Unpause the connection by setting the 'paused' parameter to 'false' in the Update a Connection endpoint request. This endpoint is only supported for Function and Connection SDK connectors.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schema_file | Yes | REQUIRED: You must first read the schema file at 'open-api-definitions/connections/modify_connection_state.json', then provide this exact path here to confirm. | |
| request_body | Yes | JSON string containing the request body. Refer to the schema file for the expected structure. | |
| connection_id | Yes | The unique identifier for the connection |