Update Task Template

Edits an existing compliance task template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Edits an existing compliance task template. A field left out of the payload keeps the value the template already
holds. 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.

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.

recurrence is the exception to the per-field rule: it is replaced as a whole, not merged. Which keys each
frequency requires, and when start_date may be moved, is on the fields themselves.

type cannot be changed: the only accepted value is the one the template already has.

Path Params
string
required

The ID of the task template.

Body Params
string
length ≤ 150

The name of the task template.

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

boolean

Whether the task cannot be completed before its scheduled day.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json