Create recurring task

Creates a new recurring task.

POST

/ v1 / recurring-tasks

Authorization

X-API-Key

string

required

Header with the name X-API-Key where the value is your API key.

Body

application/json

frequency

Frequency

required

Frequency in which the task should be scheduled.
deadlineType

string = SOFT

"HARD" or "SOFT" are the two values allowed.
duration

number

An integer greater than 0 or "REMINDER" for a reminder task.
startingOn

string

ISO 8601 Date which is trimmed to the start of the day passed, like 2024-03-12 or 2024-03-12T06:00:00.000Z (default).
idealTime

string

If possible, schedule at the ideal time if free (HH:mm).
schedule

string = Work Hours

Schedule the task must adhere to (defaults to "Work Hours" which is a schedule all users have).
name

string

required

The name of the recurring task.
workspaceId

string

required

The workspace in which to create the recurring task.
description

string

The description of the task.
priority

string = MEDIUM

"HIGH" or "MEDIUM" (which is the default).
assigneeId

string

required

To whom the recurring task should be assigned.

Response

200 - application/json - object

id

string

required

The ID of the recurring task.
name

string

required

The name of the recurring task.
description

string

required

The HTML contents of the description.
workspace

object

required

The workspace data.
- id
  
  string
  
  required
  
  The ID of the workspace.
- name
  
  string
  
  required
  
  The name of the workspace.
- teamId
  
  string
  
  required
  
  The ID of the team.
- type
  
  string
  
  required
  
  Whether the workspace is a team or individual type.
- labels
  
  array<object>
  
  required
  
  An array of labels.
  name
  
  string
  
  The name of the label.
- statuses
  
  array<object>
  
  required
  
  An array of statuses for the workspace.
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
creator

object

required

The user who created the recurring task.
- id
  
  string
  
  The user id of the creator.
- name
  
  string
  
  The name of the creator.
- email
  
  string
  
  The email of the creator.
assignee

object

required

The user assigned to the recurring task.
- id
  
  string
  
  The user id of the assignee.
- name
  
  string
  
  The name of the assignee.
- email
  
  string
  
  The email of the assignee.
project

object

The project data.
- id
  
  string
  
  required
  
  The ID of the project.
- name
  
  string
  
  required
  
  The name of the project.
- description
  
  string
  
  required
  
  The HTML contents of the description.
- workspaceId
  
  string
  
  required
  
  The ID of the workspace.
- status
  
  object
  
  The status of the project.
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
- createdTime
  
  datetime
  
  The timestamp when the project was created.
- updatedTime
  
  datetime
  
  The timestamp when the project was last updated.
- customFieldValues
  
  record<object>
  
  Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
  text
  
  object
  
  Text custom field value.
  
  type
  
  string
  
  required
  
  Always "text" for this field type.
  
  value
  
  string | null
  
  Text value or null.
  
  number
  
  object
  
  Number custom field value.
  
  type
  
  string
  
  required
  
  Always "number" for this field type.
  
  value
  
  number | null
  
  Numeric value or null.
  
  url
  
  object
  
  URL custom field value.
  
  type
  
  string
  
  required
  
  Always "url" for this field type.
  
  value
  
  string | null
  
  URL string or null.
  
  date
  
  object
  
  Date custom field value.
  
  type
  
  string
  
  required
  
  Always "date" for this field type.
  
  value
  
  string | null
  
  ISO date string or null.
  
  select
  
  object
  
  Select custom field value.
  
  type
  
  string
  
  required
  
  Always "select" for this field type.
  
  value
  
  string | null
  
  Selected option value or null.
  
  multiSelect
  
  object
  
  Multi-select custom field value.
  
  type
  
  string
  
  required
  
  Always "multiSelect" for this field type.
  
  value
  
  array<string> | null
  
  Array of selected option values or null.
  
  person
  
  object
  
  Person custom field value.
  
  type
  
  string
  
  required
  
  Always "person" for this field type.
  
  value
  
  object | null
  
  Person object or null.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  multiPerson
  
  object
  
  Multi-person custom field value.
  
  type
  
  string
  
  required
  
  Always "multiPerson" for this field type.
  
  value
  
  array<object> | null
  
  Array of person objects or null.
  
  [index]
  
  object
  
  Person object.
  
  id
  
  string
  
  required
  
  User ID of the person.
  
  name
  
  string
  
  required
  
  Name of the person.
  
  email
  
  string
  
  required
  
  Email of the person.
  
  email
  
  object
  
  Email custom field value.
  
  type
  
  string
  
  required
  
  Always "email" for this field type.
  
  value
  
  string | null
  
  Email address or null.
  
  phone
  
  object
  
  Phone custom field value.
  
  type
  
  string
  
  required
  
  Always "phone" for this field type.
  
  value
  
  string | null
  
  Phone number or null.
  
  checkbox
  
  object
  
  Checkbox custom field value.
  
  type
  
  string
  
  required
  
  Always "checkbox" for this field type.
  
  value
  
  boolean | null
  
  Boolean value or null.
  
  relatedTo
  
  object
  
  Related task custom field value.
  
  type
  
  string
  
  required
  
  Always "relatedTo" for this field type.
  
  value
  
  string | null
  
  Related task ID or null.
status

object

required

The status of the task.
- name
  
  string
  
  The name of the status.
- isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
- isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.
priority

string

required

Valid options are ASAP, HIGH, MEDIUM, or LOW.
labels

array<object>

required

An array of labels.
- name
  
  string
  
  The name of the label.