PATCH /user_tasks/{taskId}/cancel
Cancels the specified user task with the provided reason. Requires the user_tasks:write scope.
Servers
- https://api.retool.com/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
taskId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | Yes |
Email of user cancelling the task. |
output |
Object | No |
Assignee-defined output required for a task to be cancelled. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.