This request method allows you to update an existing recurring task.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/taskrecurring?format=xml/json

You may use either JSON or XML formats in your PUT submission.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.

If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”

Endpoints & API Explorer

Parameters

The PUT verb allows you to update any existing recurring task in your account.
The required and optional parameters for a PUT call to the Task Recurring API are outlined below.

✓* – At least one of these values is required.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

https://eforms.mobileform.net:443/api/v2/taskrecurring

Response Body

{
  "TaskRecurring": {
    "Name": "UpdateTest Recurring Task (name)2",
    "Description": "Test Recurring Task (description)2",
    "RepeatEvery": 1,
    "WeeklySelectedDays": [],
    "Occurrences": 4,
    "Id": "eb5379084bda49549955b23c0038df86",
    "ExternalId": "DeviceAlias",
    "UserId": "85589128040b48e591ccb1f0002ca765",
    "TemplateId": "d8379984ea364b1686cfb23c00138de6",
    "IsAllDay": true,
    "RestrictToGroup": "00000000000000000000000000000000",
    "UserCanReassign": false,
    "Activities": [
      {
        "FormId": "8995af1ede6f4ff3999cb1f0001b2314",
        "ActivityType": "FillOutForm",
        "ActivityId": "97a32a68-8160-42c4-b8ca-b23c0038d3c0",
        "IsOptional": false
      },
      {
        "Name": "Instruction A",
        "FormId": "8995af1ede6f4ff3999cb1f0001b2314",
        "ActivityType": "FillOutForm",
        "ActivityId": "0df777d7a05942f8976eb23c0097ce0c",
        "IsOptional": true
      },
      {
        "Name": "Instruction B",
        "FormId": "8995af1ede6f4ff3999cb1f0001b2314",
        "ActivityType": "FillOutForm",
        "ActivityId": "5a319528c7ce4c28880cb23c0097ce0c",
        "IsOptional": false
      },
      {
        "Name": "Instruction C",
        "FormId": "8995af1ede6f4ff3999cb1f0001b2314",
        "ActivityType": "FillOutForm",
        "ActivityId": "6410736b4a5a4dd1bd52b23c0097ce0c",
        "IsOptional": false
      }
    ],
    "Files": [
      {
        "FileName": "bird.jpg",
        "Desc": "test",
        "OnDemand": true,
        "Uploaded": true
      },
      {
        "FileName": "Goat.jpg",
        "Desc": "my Goat",
        "OnDemand": false
      }
    ],
    "History": [
      {
        "TaskRecurringType": "Monthly",
        "NextOccurrence": "2024-12-04T13:30:00.0000000Z",
        "Status": "NotStarted",
        "StartingOn": "2024-12-04T13:30:00.0000000Z",
        "EndingOn": "2025-01-05T13:29:00.0000000Z",
        "IsAllDay": true,
        "TotalOccurrences": 2,
        "DateModifiedUtc": "2024-12-04T03:27:04.1280000Z",
        "WeeklySelectedDays": [],
        "RepeatEvery": 1,
        "Ends": "After",
        "AppUserId": "85589128040b48e591ccb1f0002ca765"
      },
      {
        "TaskRecurringType": "Monthly",
        "NextOccurrence": "2024-12-04T13:30:00.0000000Z",
        "Status": "NotStarted",
        "StartingOn": "2024-12-04T13:30:00.0000000Z",
        "EndingOn": "2025-03-05T13:29:00.0000000Z",
        "IsAllDay": true,
        "TotalOccurrences": 4,
        "DateModifiedUtc": "2024-12-04T09:12:42.2820000Z",
        "WeeklySelectedDays": [],
        "RepeatEvery": 1,
        "Ends": "On",
        "AppUserId": "85589128040b48e591ccb1f0002ca765"
      }
    ],
    "Schedule": [
      {
        "Start": "2024-12-04T13:30:00.0000000Z",
        "End": "2024-12-05T13:29:00.0000000Z",
        "TaskId": "961d795282674b90bf59b23c0097ce87",
        "TaskEdited": false
      },
      {
        "Start": "2025-01-04T13:30:00.0000000Z",
        "End": "2025-01-05T13:29:00.0000000Z",
        "TaskId": "8a0a1f696050434da332b23c0097ce95",
        "TaskEdited": false
      },
      {
        "Start": "2025-02-04T13:30:00.0000000Z",
        "End": "2025-02-05T13:29:00.0000000Z",
        "TaskId": "59e29932f04844428ccfb23c0097cea3"
      },
      {
        "Start": "2025-03-04T13:30:00.0000000Z",
        "End": "2025-03-05T13:29:00.0000000Z",
        "TaskId": "2cc2474a56094d4f841bb23c0097cead"
      }
    ],
    "AdvanceRecurrences": 6,
    "CompanyId": XX
  }
}