diff --git a/connector-api/_generator/types.yaml b/connector-api/_generator/types.yaml index 525e693e..4975bde7 100644 --- a/connector-api/_generator/types.yaml +++ b/connector-api/_generator/types.yaml @@ -2616,3 +2616,6 @@ types: paymentmethodrequestemailtypesenum: file: paymentmethodrequests.md anchor: supported-email-types + closetaskparameters: + file: tasks.md + anchor: closetaskparameters diff --git a/connector-api/changelog/README.md b/connector-api/changelog/README.md index 5d3a8a67..d35aec0f 100644 --- a/connector-api/changelog/README.md +++ b/connector-api/changelog/README.md @@ -1,6 +1,14 @@ # Changelog {% updates format="full" %} +{% update date="2026-02-27" %} + +## New operation: Close tasks + +- [Close tasks](../operations/tasks.md#close-task): + - New operation to close tasks. + +{% endupdate %} {% update date="2026-02-25" %} ## 25th February 2026 diff --git a/connector-api/operations/README.md b/connector-api/operations/README.md index 24a59b21..c0a6b078 100644 --- a/connector-api/operations/README.md +++ b/connector-api/operations/README.md @@ -94,6 +94,7 @@ This section describes all operations supported by the API, organised here by th | [Add resource block](resourceblocks.md#add-resource-block) | Adds a new resource block to the specified resource for a defined period of time | | [Delete resource blocks](resourceblocks.md#delete-resource-blocks) | Removes specified resource blocks from the resources | | [Add task](tasks.md#add-task) | Adds a new task to the enterprise, optionally to a specified department | +| [Close task](tasks.md#close-tasks) | Closes one or more tasks. | | [Get all tasks](tasks.md#get-all-tasks) | Returns all tasks of the enterprise, filtered by identifiers or other filters | | [Get all resource categories](resourcecategories.md#get-all-resource-categories) | Returns all resource categories of an enterprise associated with the connector integration | | [Get all resource category assignments](resourcecategories.md#get-all-resource-category-assignments) | Returns all resource category assignments of an enterprise associated with the connector integration | diff --git a/connector-api/operations/tasks.md b/connector-api/operations/tasks.md index b60c700d..a027bb97 100644 --- a/connector-api/operations/tasks.md +++ b/connector-api/operations/tasks.md @@ -135,3 +135,39 @@ Adds a new task to the enterprise, optionally to a specified department. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | | `TaskId` | string | required | Unique identifier of added task. | + +## Close task + +> ### Restricted! +> This operation is currently in beta-test and as such it is subject to change. + +Closes one or more tasks. Closed tasks are considered completed and not shown in active task lists. + +### Request + +`[PlatformAddress]/api/connector/v1/tasks/close` + +```javascript +{ + "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", + "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", + "Client": "Sample Client 1.0.0", + "TaskIds": [ + "a7f6f8a1-6a2c-4c4d-8b9f-3c8a6d2f1b7e", + "b4c2d9fe-12a1-4c2b-9f6a-5b0c2f1d3e4a" + ] +} +``` + +| Property | Type | Contract | Description | +| :-- | :-- | :-- | :-- | +| `ClientToken` | string | required | Token identifying the client application. | +| `AccessToken` | string | required | Access token of the client application. | +| `Client` | string | required | Name and version of the client application. | +| `TaskIds` | array of string | required, max 100 items | Unique identifiers of the Tasks to be closed. | + +### Response + +```javascript +{} +```