API ReferenceChecklist

Merge To Main

Merges the given branch to the “main” branch. Throws if the checklist or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you merge with an archived checklist.

Path parameters

checklistRidstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
branchNamestringRequired

If “main”, the request will throw.

messagestringRequired
latestCommitOnMainstringOptional

If present, will validate that the latest commit matches this id, and otherwise throw CommitConflict.

Response

This endpoint returns an object.
ridstring
metadataobject
commitobject
functionslist of objects

A list of functions that are available to be used by checks in this checklist.

checkslist of objects
checklistVariableslist of objects

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.