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
TwoSms.CustomerPortalRole.API.Admin.Tasks.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. |
TwoSms.Platform.Database.CustomerPortal.Tables.Task.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. |
TwoSms.Platform.Database.CustomerPortal.Tables.Task.TaskNotification |
None. |
Request Formats
application/json, text/json
Sample:
{ "Enabled": true, "TaskID": "b00e0f50-e8dd-45cd-be14-c07cee3209a5", "Frequency": 0, "StartDate": "2024-04-20T01:36:33.1454963+00:00", "FinishDate": "2024-04-20T01:36:33.1454963+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>b00e0f50-e8dd-45cd-be14-c07cee3209a5</TaskID> <Frequency>NONE</Frequency> <StartDate>2024-04-20T01:36:33.1454963+00:00</StartDate> <FinishDate>2024-04-20T01:36:33.1454963+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:
Response Information
Resource Description
TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskResponseName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskResponse |
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": "0ebb6126-2397-4da3-ab38-2901d083f32e", "TaskID": "153b1bed-0670-4f60-b27f-9d78fa6cb322", "Name": "sample string 3", "Enabled": true, "Frequency": "sample string 5", "StartDate": "2024-04-20T01:36:33.1545043+00:00", "FinishDate": "2024-04-20T01:36:33.1545043+00:00", "Parameters": "sample string 7", "ContentType": "sample string 8", "Notification": "sample string 9", "DateCreated": "2024-04-20T01:36:33.1545043+00:00", "DateModified": "2024-04-20T01:36:33.1545043+00:00", "LastRunOn": "2024-04-20T01:36:33.1545043+00:00", "LastRunBy": "sample string 11", "LastModifiedBy": "sample string 12", "Status": "sample string 13", "ClientID": "16cd0a91-79b9-40f1-844e-c94e33c34e91" } } }