API Docs

Update task

Update a task.

PATCH
/ v1 / tasks / {id}

Authorization

  • X-API-Key
    string
    required

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

Path parameters

  • id
    string

    The id of the task to update.

Body

application/json

  • dueDate
    datetime

    ISO 8601 Due date on the task. REQUIRED for scheduled tasks.

  • duration
    string | number

    A duration can be one of the following... "NONE", "REMINDER", or an integer greater than 0 (representing minutes).

  • status
    string

    Defaults to workspace default status.

  • autoScheduled
    object | null

    Set values to turn auto scheduling on, set value to null if you want to turn auto scheduling off. The status for the task must have auto scheduling enabled.

  • name
    string
    required

    Title of the task.

  • projectId
    string

    The project ID the task should be associated with.

  • workspaceId
    string
    required

    The workspace ID the task should be associated with.

  • description
    string

    Github Flavored Markdown for the input.

  • priority
    string

    ASAP, HIGH, MEDIUM, and LOW are valid values.

  • labels
    array<string>

    The names of the labels to be added to the task.

  • assigneeId
    string

    The user id the task should be assigned to.

Response

200 - application/json - object

  • id
    string
    required

    The ID of the task.

  • name
    string
    required

    The name of the task.

  • description
    string
    required

    The HTML contents of the description.

  • duration
    string | number

    An integer greater than 0 (representing minutes), "NONE", or "REMINDER".

  • dueDate
    datetime

    When is the task due.

  • deadlineType
    string
    required

    Values are HARD, SOFT (default) or NONE.

  • parentRecurringTaskId
    string
    required

    If this is an instance of a recurring task, this field will be the parent recurring task id.

  • completed
    boolean
    required

    Whether the task is completed or not.

  • completedTime
    datetime

    The timestamp when the task was completed.

  • updatedTime
    datetime

    The timestamp when the task was last updated.

  • startOn
    string

    Date indicating when a task should start, in YYYY-MM-DD format.

  • creator
    object
    required

    The user who created the task.

  • project
    object

    The project data.

  • workspace
    object
    required

    The workspace data.

  • status
    object
    required

    The status of the The status of the task.

  • priority
    string
    required

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

  • labels
    array<object>
    required

    An array of labels.

  • assignees
    array<object>
    required

    An array of assignees.

  • scheduledStart
    datetime

    The time that motion has scheduled this task to start.

  • createdTime
    datetime
    required

    The time that the task was created.

  • scheduledEnd
    datetime

    The time that motion has scheduled this task to end.

  • schedulingIssue
    boolean
    required

    Returns true if Motion was unable to schedule this task. Check Motion directly to address.

  • lastInteractedTime
    datetime

    The timestamp when the task was last interacted with.

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

  • chunks
    array<object>

    Array of scheduling chunks for the task.