API Endpoints
Go to Apicbase

Save Task Occurrence

patch
https://api.apicbase.com/api/v2/compliance/tasks/occurrences//

Saves or completes a task occurrence.

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

Requires permission to perform the task in the occurrence's outlet. Editing an occurrence that is already completed additionally requires the permission to edit completed tasks; without it, only remarks and custom_fields are accepted and a payload touching any other field answers 403. Attachments are never touched by this endpoint.

Completion is one-way: an occurrence that is already completed cannot be sent back to draft with completed: false. The response is the full occurrence, in the same shape as Get Task Occurrence Details.

The two type_specific keys merge by opposite rules, and completion has several preconditions of its own. Both are covered in the Completing Task Occurrences guide.

Path Params
string
required

The opaque occurrence token from the calendar endpoint.

Body Params
boolean

True completes the occurrence, false saves it as a draft. Left out, the occurrence keeps the state it is in.

string

The remarks entered on the occurrence.

string | null

The ID of the user who performed the task, reported back as completion.done_by. Left out, it is not changed.

boolean

True records that the corrective action was deliberately skipped.

type_specific
object

The values entered for the occurrence's own task type, one key per type. See Template types.

custom_fields
object

The values of the library's task custom fields, keyed by field slug.

Responses

Updated 19 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

Did this page help you?