Docs

Create Variable

POST /documents/{documentId}/variables

POST/documents/{documentId}/variables

Adds a named input variable to a document (type Collaborator, Area, Activity, Crew, ResourceType, Date or Text). Query filters reference it as "$var:" followed by the variable id to scope results at render time. A required variable makes the query fail when unresolved. Requires the EventDocumentsEdit permission or a share on the document.

Path Parameters

FieldTypeRequiredDescription
documentIduuidRequired

Request Body

FieldTypeRequiredDescription
namestringOptional
variableTypestringOptional
isMultiSelectbooleanOptional
isRequiredbooleanOptional
defaultValuesstringOptional