# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## manage_workspace_variables

List, create, update, or delete organization variables used as substitution values in campaign content.

Use to manage the workspace-level key/value pairs that campaigns can reference as variables.

Variable keys must be unique per workspace and follow the allowed key grammar; values are never shown in telemetry.

Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.

Scopes: workspace:read, workspace:update

Risk: write; confirmation: explicit; idempotency: supported.

### Input schema (personal API key)

```json
{
  "type": "object",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "list"
              ]
            }
          ]
        }
      },
      "required": [
        "workspaceId",
        "action"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "workspaceId",
          "action"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "create"
              ]
            }
          ]
        },
        "input": {
          "type": "object",
          "properties": {
            "key": {
              "$ref": "#/$defs/OrganizationVariableKey"
            },
            "value": {
              "$ref": "#/$defs/OrganizationVariableValue"
            },
            "label": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 100
                },
                {
                  "type": "null"
                }
              ]
            },
            "description": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "key",
            "value"
          ],
          "patternProperties": {
            "^(?!(?:key|value|label|description)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "key",
              "value",
              "label",
              "description"
            ]
          }
        }
      },
      "required": [
        "workspaceId",
        "action",
        "input"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId|action|input)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "workspaceId",
          "action",
          "input"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "update"
              ]
            }
          ]
        },
        "variableId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "input": {
          "type": "object",
          "properties": {
            "value": {
              "$ref": "#/$defs/OrganizationVariableValue"
            },
            "label": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 100
                },
                {
                  "type": "null"
                }
              ]
            },
            "description": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "patternProperties": {
            "^(?!(?:value|label|description)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "value",
              "label",
              "description"
            ]
          },
          "minProperties": 1,
          "maxProperties": 3
        }
      },
      "required": [
        "workspaceId",
        "action",
        "variableId",
        "input"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId|action|variableId|input)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "workspaceId",
          "action",
          "variableId",
          "input"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "delete"
              ]
            }
          ]
        },
        "variableId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      },
      "required": [
        "workspaceId",
        "action",
        "variableId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId|action|variableId)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "workspaceId",
          "action",
          "variableId"
        ]
      }
    }
  ],
  "$defs": {
    "OrganizationVariableKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "OrganizationVariableValue": {
      "type": "string",
      "minLength": 1,
      "maxLength": 10000
    }
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
    }
  },
  "required": [
    "workspaceId"
  ],
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "list"
              ]
            }
          ]
        }
      },
      "required": [
        "workspaceId",
        "action"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "workspaceId",
              "action"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "create"
              ]
            }
          ]
        },
        "input": {
          "type": "object",
          "properties": {
            "key": {
              "$ref": "#/$defs/OrganizationVariableKey"
            },
            "value": {
              "$ref": "#/$defs/OrganizationVariableValue"
            },
            "label": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 100
                },
                {
                  "type": "null"
                }
              ]
            },
            "description": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "key",
            "value"
          ],
          "patternProperties": {
            "^(?!(?:key|value|label|description)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "key",
              "value",
              "label",
              "description"
            ]
          }
        }
      },
      "required": [
        "workspaceId",
        "action",
        "input"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|input)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "workspaceId",
              "action",
              "input"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "update"
              ]
            }
          ]
        },
        "variableId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "input": {
          "type": "object",
          "properties": {
            "value": {
              "$ref": "#/$defs/OrganizationVariableValue"
            },
            "label": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 100
                },
                {
                  "type": "null"
                }
              ]
            },
            "description": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "patternProperties": {
            "^(?!(?:value|label|description)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "value",
              "label",
              "description"
            ]
          },
          "minProperties": 1,
          "maxProperties": 3
        }
      },
      "required": [
        "workspaceId",
        "action",
        "variableId",
        "input"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|variableId|input)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "workspaceId",
              "action",
              "variableId",
              "input"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "delete"
              ]
            }
          ]
        },
        "variableId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      },
      "required": [
        "workspaceId",
        "action",
        "variableId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|variableId)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "workspaceId",
              "action",
              "variableId"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    }
  ],
  "$defs": {
    "OrganizationVariableKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "OrganizationVariableValue": {
      "type": "string",
      "minLength": 1,
      "maxLength": 10000
    }
  }
}
```

### Output schema (structuredContent)

```json
{
  "$defs": {
    "OrganizationVariableKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "OrganizationVariableValue": {
      "type": "string",
      "minLength": 1,
      "maxLength": 10000
    },
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    }
  },
  "type": "object",
  "anyOf": [
    {
      "allOf": [
        {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 64
                      },
                      "key": {
                        "$ref": "#/$defs/OrganizationVariableKey"
                      },
                      "value": {
                        "$ref": "#/$defs/OrganizationVariableValue"
                      },
                      "label": {
                        "anyOf": [
                          {
                            "type": "string",
                            "maxLength": 100
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "description": {
                        "anyOf": [
                          {
                            "type": "string",
                            "maxLength": 500
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "createdAt": {
                        "$ref": "#/$defs/UtcDateTimeEncoded"
                      },
                      "updatedAt": {
                        "$ref": "#/$defs/UtcDateTimeEncoded"
                      }
                    },
                    "required": [
                      "id",
                      "key",
                      "value",
                      "label",
                      "description",
                      "createdAt",
                      "updatedAt"
                    ],
                    "patternProperties": {
                      "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false
                    },
                    "additionalProperties": true,
                    "propertyNames": {
                      "type": "string",
                      "enum": [
                        "id",
                        "key",
                        "value",
                        "label",
                        "description",
                        "createdAt",
                        "updatedAt"
                      ]
                    }
                  }
                }
              },
              "required": [
                "items"
              ],
              "patternProperties": {
                "^(?!(?:items)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "items"
                    ]
                  }
                ]
              }
            },
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "key": {
                  "$ref": "#/$defs/OrganizationVariableKey"
                },
                "value": {
                  "$ref": "#/$defs/OrganizationVariableValue"
                },
                "label": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 100
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 500
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "createdAt": {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                "updatedAt": {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                }
              },
              "required": [
                "id",
                "key",
                "value",
                "label",
                "description",
                "createdAt",
                "updatedAt"
              ],
              "patternProperties": {
                "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "type": "string",
                "enum": [
                  "id",
                  "key",
                  "value",
                  "label",
                  "description",
                  "createdAt",
                  "updatedAt"
                ]
              }
            },
            {
              "type": "object",
              "properties": {
                "deleted": {
                  "anyOf": [
                    {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  ]
                }
              },
              "required": [
                "deleted"
              ],
              "patternProperties": {
                "^(?!(?:deleted)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "deleted"
                    ]
                  }
                ]
              }
            }
          ]
        },
        {
          "type": "object"
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "allOf": [
            {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 64
                          },
                          "key": {
                            "$ref": "#/$defs/OrganizationVariableKey"
                          },
                          "value": {
                            "$ref": "#/$defs/OrganizationVariableValue"
                          },
                          "label": {
                            "anyOf": [
                              {
                                "type": "string",
                                "maxLength": 100
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "description": {
                            "anyOf": [
                              {
                                "type": "string",
                                "maxLength": 500
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "createdAt": {
                            "$ref": "#/$defs/UtcDateTimeEncoded"
                          },
                          "updatedAt": {
                            "$ref": "#/$defs/UtcDateTimeEncoded"
                          }
                        },
                        "required": [
                          "id",
                          "key",
                          "value",
                          "label",
                          "description",
                          "createdAt",
                          "updatedAt"
                        ],
                        "patternProperties": {
                          "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false
                        },
                        "additionalProperties": true,
                        "propertyNames": {
                          "type": "string",
                          "enum": [
                            "id",
                            "key",
                            "value",
                            "label",
                            "description",
                            "createdAt",
                            "updatedAt"
                          ]
                        }
                      }
                    }
                  },
                  "required": [
                    "items"
                  ],
                  "patternProperties": {
                    "^(?!(?:items)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "items"
                        ]
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64
                    },
                    "key": {
                      "$ref": "#/$defs/OrganizationVariableKey"
                    },
                    "value": {
                      "$ref": "#/$defs/OrganizationVariableValue"
                    },
                    "label": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 100
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "description": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 500
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "createdAt": {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    },
                    "updatedAt": {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    }
                  },
                  "required": [
                    "id",
                    "key",
                    "value",
                    "label",
                    "description",
                    "createdAt",
                    "updatedAt"
                  ],
                  "patternProperties": {
                    "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "id",
                      "key",
                      "value",
                      "label",
                      "description",
                      "createdAt",
                      "updatedAt"
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "deleted": {
                      "anyOf": [
                        {
                          "type": "boolean",
                          "enum": [
                            true
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "deleted"
                  ],
                  "patternProperties": {
                    "^(?!(?:deleted)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "deleted"
                        ]
                      }
                    ]
                  }
                }
              ]
            },
            {
              "not": {
                "type": "object"
              }
            }
          ]
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false
    }
  ]
}
```

### Underlying API operations

- `organizationVariables.list`: `GET /v1/workspaces/:workspaceId/settings/variables`
- `organizationVariables.create`: `POST /v1/workspaces/:workspaceId/settings/variables`
- `organizationVariables.update`: `PATCH /v1/workspaces/:workspaceId/settings/variables/:variableId`
- `organizationVariables.delete`: `DELETE /v1/workspaces/:workspaceId/settings/variables/:variableId`

