UpdateJobAidRequest

A request or response body; the type column links to the schemas it refers to.

UpdateJobAidRequest

Field	Type	Required	Description
title	string	no	1–200 characters
description	string \| null	no	Send null or empty to clear the summary. at most 2000 characters
body_markdown	string \| null	no	Send null or empty to clear the body. at most 200000 characters
audience	string	no	Whom the job aid is for. trainees: everyone its ownership admits — every member for an organization-owned aid, the owning department's role holders for a department-owned one — trainers included. trainers: only holders of job-aids:read over the aid's owner, for facilitator guides and the like; the aid is absent from everyone else's list. one of "trainees" \| "trainers"
archived	boolean	no	True archives the job aid (hidden from its audience); false restores it.
require_recertification	boolean	no	True moves the aid's recertification cutoff to now: opens recorded before this edit stop satisfying job_aid_viewed rules, so everyone certified on the aid must read it again. For a rewrite that changes what readers must know, not for a typo. Omit or send false to leave every earlier open standing.

jsonExample

{
  "title": "string",
  "description": "string",
  "body_markdown": "string",
  "audience": "trainees",
  "archived": true,
  "require_recertification": true
}