Add an action to a year's memo

One of three shapes. A catalogue entry (catalogueKey, optional reductionPct within the entry's range, baseId when the entry applies to several bases). A base with the user's or Tally's own percentage (title, baseId, reductionPct, rationale). A typed estimate (title, scope, estimateKgCo2e, rationale). Core works out the estimate; a percentage outside a catalogue entry's range needs a rationale and makes the estimate a tally one. 404 ACTION_MEMO_NOT_FOUND; 400 VALIDATION_ERROR (the message says why). Requires org.edit_dashboard.

post/net-zero/action-memos/{year}/actions

Path parameters

yearinteger required

Request body

baseIdstring

A NetZeroActionBase.id from the catalogue's bases.

catalogueKeystring
descriptionstring

Defaults to the catalogue entry's description.

dueQuarterinteger
estimateKgCo2enumber double
ownerstring
progressNotestring
rationalestring
reductionPctnumber double
scopeinteger

Needed for a typed estimate; otherwise it must match the base.

scope3Categoryinteger
siteIdstring

A site external id inside the workspace (400 otherwise). A site the user places the action at (a typed estimate, or a label on an organization-wide base) must be active; a base's own site may be archived.

status'planned' | 'in_progress' | 'done' | 'dropped'
titlestring

Defaults to the catalogue entry's title.

Response

The new action

Changes

Changed in 1 of the 8 revisions of this API.1