Endpoint: Updating a Task

This endpoint is used to update properties of a task.

Request Body

{
  fields: {
    title?: string;
    active?: boolean;
    activeBefore?: number | null;// seconds
    activeAfter?: number | null; // seconds
    lang?: "en" | "es" | "fr" | "tr" | "nl" | "it" | "sr" | "sv" | "de" | "no" | "ru" | "pt";
    favorite?: boolean;
    folder?: string;
    labels?: {
      add?: string[];
      remove?: string[];
    };
  };

  steps?: Record<
    string /* step id */, 
    {
      title?: string;
      active?: boolean;
      activeBefore?: number | null;// seconds
      activeAfter?: number | null;// seconds
      attemptLimit?: number; // -1 for unlimited
    }
  >;
};

The values for title, folder and labels must be at least 2 characters, and must not contain these characters: <, >, /

To set dates after and before which the task, and/or each individual step should be accessible by candidates, a timestamp value in seconds can be provided to activeBefore and/or activeAfter properties. To remove a date restriction from these fields, these properties can be set to null.

To edit a step under the task, a record with the step's id (key) and an object (value) containing the settings to be edited can be added to request body.

A step's attempt limit can be set to unlimited by setting attemptLimit to -1. 

Response

Upon a successful request, a detailed task object will be returned. The task object is the same as the one obtained from the GET requests for tasks, mentioned earlier in the documentation.