Update Task Template

patch

https://api.apicbase.com/api/v2/compliance/tasks/{template_id}/

Edits an existing compliance task template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Requires permission to manage compliance tasks in the outlets the template is scheduled in, both the ones it takes on and the ones it drops. type cannot be changed: the only accepted value is the one the template already has.

Editing writes a new version of the template. Occurrences that were already completed keep the version they were completed under, while the template_id in the URL and the id in the response stay the same across versions.

Path Params

template_id

string

required

The ID of the task template.

Body Params

name

string

length ≤ 150

The name of the task template.

description

string

The description of the task template.

outlets

array of strings

length ≥ 1

The IDs of the outlets to schedule the task in. Outlet users can only list outlets they are connected to; the outlets of the template they have no access to are kept as they are.

outlets

assignee

string | null

The ID of the user the task is assigned to. Only accepted when the task is scheduled in a single outlet — a template spanning several outlets cannot carry an assignee. An outlet user has to have access to that outlet.

prevent_early_execution

boolean

Whether the task cannot be completed before its scheduled day.

active

boolean

Whether the schedule is enabled.

recurrence

object

The schedule of the template. It is written as a whole: a request that touches it carries every key its frequency requires.

type_specific

object

The type-dependent definitions of the template. Which keys apply — and which of them are required — is decided by type. See Template types.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad request — the payload failed validation, or a schedule rule refused it.

403Forbidden — the Tasks module is off, or the user cannot manage compliance tasks.

404Template not found.

409Conflict — another request holds the lock on the template's schedule.