Docs
Update Variable
PUT /documents/{documentId}/variables/{variableId}
PUT
/documents/{documentId}/variables/{variableId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder. |
Replaces all fields on an existing document variable. All fields are required — this is a full replacement, not a partial update.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Display label for the variable. |
| variableType | string | Required | Type of the variable. One of: `Collaborator`, `Area`, `Activity`, `Crew`, `ResourceType`, `Date`, `Text`. |
| isMultiSelect | boolean | Required | Whether the variable accepts multiple values. |
| isRequired | boolean | Required | Whether the variable must be resolved before query execution. |
| defaultValues | string | Optional | JSON array of default values, or `null` to clear. |
Response
200 OK with no body.