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.AccountTaskUpdateRequest

Name	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": "5a72635c-eda1-4c62-ae92-6096c512cbbb",
  "Frequency": 0,
  "StartDate": "2024-11-21T08:55:34.7324532+00:00",
  "FinishDate": "2024-11-21T08:55:34.7324532+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>5a72635c-eda1-4c62-ae92-6096c512cbbb</TaskID>
  <Frequency>NONE</Frequency>
  <StartDate>2024-11-21T08:55:34.7324532+00:00</StartDate>
  <FinishDate>2024-11-21T08:55:34.7324532+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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskUpdateRequest'.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Tasks.AccountTaskResponse

Name	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": "040c857c-5eda-42d3-accf-58c1a1b4cb8c",
      "TaskID": "b3d78c6a-c7fa-489f-b825-f53524996ffe",
      "Name": "sample string 3",
      "Enabled": true,
      "Frequency": "sample string 5",
      "StartDate": "2024-11-21T08:55:34.7416183+00:00",
      "FinishDate": "2024-11-21T08:55:34.7416183+00:00",
      "Parameters": "sample string 7",
      "ContentType": "sample string 8",
      "Notification": "sample string 9",
      "DateCreated": "2024-11-21T08:55:34.7416183+00:00",
      "DateModified": "2024-11-21T08:55:34.7416183+00:00",
      "LastRunOn": "2024-11-21T08:55:34.7416183+00:00",
      "LastRunBy": "sample string 11",
      "LastModifiedBy": "sample string 12",
      "Status": "sample string 13",
      "ClientID": "5fe3e156-d9fc-49c9-9c90-3b99c9d1c01d"
    }
  }
}