Create Recurring Task

POST 
/locations/:locationId/recurring-tasks

Create Recurring Task

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

application/json

application/json

Body

Bodyrequired

titlestringrequired

Name of the task

descriptionstring

Description of the task

contactIdsstring[]

Contact Id

ownersstring[]

Assigned To

rruleOptionsobjectrequired

Recurring rules

ignoreTaskCreationboolean

Create initial task or not

Example (auto)

{
  "title": "Task Name",
  "description": "Task Description",
  "contactIds": [
    "sx6wyHhbFdRXh302Lunr"
  ],
  "owners": [
    "sx6wyHhbFdRXh302Lunr"
  ],
  "rruleOptions": {
    "intervalType": "hourly",
    "interval": 1,
    "startDate": "2025-07-23T10:00:00.000Z",
    "dueAfterSeconds": 600
  },
  "ignoreTaskCreation": true
}

application/json

Successful response

application/json

Schema

Schema

recurringTaskobjectrequired

Recurring Tasks

Example (auto)

{
  "recurringTask": {
    "id": "sx6wyHhbFdRXh302Lunr",
    "title": "Task Name",
    "description": "Task Description",
    "locationId": "sx6wyHhbFdRXh302Lunr",
    "updatedAt": "2021-04-15T10:00:00.000Z",
    "createdAt": "2021-04-15T10:00:00.000Z",
    "rruleOptions": {
      "createTaskIfOverDue": false,
      "interval": 1,
      "intervalType": "hourly",
      "startDate": "2024-10-29T12:34:03.000Z",
      "dueAfterSeconds": 600,
      "count": 550
    },
    "totalOccurrence": 10,
    "deleted": false,
    "assignedTo": "sx6wyHhbFdRXh302Lunr",
    "contactId": "v5cEPM428h8vShlRW1KT"
  }
}