PUT api/v1/admin/tasks/account/{id}
Updates an existing task on the account.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the task that is being updated. |
globally unique identifier |
Required |
Body Parameters
The new details of the task
AccountTaskUpdateRequestName | Description | Type | Additional information |
---|---|---|---|
Enabled |
Determines whether the task registered on the account is enabled or disabled. |
boolean |
None. |
TaskID |
The ID of the task to be registered. |
globally unique identifier |
Required |
Frequency |
How often the task should run. |
Frequency |
Required |
StartDate |
Determines when the task should start running. |
date |
None. |
FinishDate |
Determines when the task should stop running. |
date |
None. |
Parameters |
The parameters for the task. |
string |
Required |
ContentType |
The format the parameters are in. Must either be application/xml or application/json. |
string |
Required |
Notification |
Determines the notifications the task could send back to the user. |
TaskNotification |
None. |
Request Formats
application/json, text/json
Sample:
{ "Enabled": true, "TaskID": "ebc72d8a-46f3-4205-bb4b-fdbc142638a2", "Frequency": 0, "StartDate": "2025-10-21T13:08:40.8693849+00:00", "FinishDate": "2025-10-21T13:08:40.8693849+00:00", "Parameters": "sample string 3", "ContentType": "sample string 4", "Notification": 0 }
application/xml, text/xml
Sample:
<AccountTaskUpdateRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TaskID>ebc72d8a-46f3-4205-bb4b-fdbc142638a2</TaskID> <Frequency>NONE</Frequency> <StartDate>2025-10-21T13:08:40.8693849+00:00</StartDate> <FinishDate>2025-10-21T13:08:40.8693849+00:00</FinishDate> <Parameters>sample string 3</Parameters> <ContentType>sample string 4</ContentType> <Notification>NONE</Notification> <Enabled>true</Enabled> </AccountTaskUpdateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfAccountTaskResponseName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfAccountTaskResponse |
None. |
Response Formats
application/json, text/json
Sample:
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": { "ID": "7592dcf8-a70c-4550-8d3d-6f46d1f10a37", "TaskID": "875a4fd1-135c-4179-b50c-dedaa520856e", "Name": "sample string 3", "Enabled": true, "Frequency": "sample string 5", "StartDate": "2025-10-21T13:08:40.8753833+00:00", "FinishDate": "2025-10-21T13:08:40.8753833+00:00", "Parameters": "sample string 7", "ContentType": "sample string 8", "Notification": "sample string 9", "DateCreated": "2025-10-21T13:08:40.8753833+00:00", "DateModified": "2025-10-21T13:08:40.8753833+00:00", "LastRunOn": "2025-10-21T13:08:40.8753833+00:00", "LastRunBy": "sample string 11", "LastModifiedBy": "sample string 12", "Status": "sample string 13", "ClientID": "5346d652-e873-43dc-bc8f-6f4fdf0f3bca" } } }