Loading update_integration_share
update_integration_share

Add workspaces to an existing share, or change whether workspaces created later join it.
# 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)

## update_integration_share

Add workspaces to an existing share, or change whether workspaces created later join it.

Use on the source workspace of a share. Detached workspaces are not re-added; their admins re-attach themselves.

Use detach_integration_share or revoke_integration_share to narrow a share.

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: integration:create

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

### Input schema (personal API key)

```json
{
  "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"
    },
    "shareId": {
      "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"
    },
    "addWorkspaceIds": {
      "type": "array",
      "items": {
        "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"
      },
      "maxItems": 500
    },
    "includeFutureWorkspaces": {
      "type": "boolean"
    }
  },
  "required": [
    "workspaceId",
    "shareId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|shareId|addWorkspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "shareId",
      "addWorkspaceIds",
      "includeFutureWorkspaces"
    ]
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "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"
    },
    "shareId": {
      "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"
    },
    "addWorkspaceIds": {
      "type": "array",
      "items": {
        "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"
      },
      "maxItems": 500
    },
    "includeFutureWorkspaces": {
      "type": "boolean"
    }
  },
  "required": [
    "workspaceId",
    "shareId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|shareId|addWorkspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "shareId",
      "addWorkspaceIds",
      "includeFutureWorkspaces"
    ]
  }
}
```

### Output schema (structuredContent)

```json
{
  "type": "object",
  "properties": {
    "id": {
      "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"
    },
    "adapter": {
      "$ref": "#/$defs/IntegrationShareAdapter"
    },
    "provider": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_-]{0,63}$"
    },
    "displayName": {
      "$ref": "#/$defs/ShortText"
    },
    "role": {
      "type": "string",
      "enum": [
        "source",
        "target"
      ]
    },
    "sourceWorkspaceId": {
      "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"
    },
    "sourceWorkspaceName": {
      "anyOf": [
        {
          "$ref": "#/$defs/ShortText"
        },
        {
          "type": "null"
        }
      ]
    },
    "sourceConnectionId": {
      "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"
    },
    "sourceConnected": {
      "type": "boolean"
    },
    "includeFutureWorkspaces": {
      "type": "boolean"
    },
    "createdAt": {
      "$ref": "#/$defs/UtcDateTimeEncoded"
    },
    "revokedAt": {
      "anyOf": [
        {
          "$ref": "#/$defs/UtcDateTimeEncoded"
        },
        {
          "type": "null"
        }
      ]
    },
    "targets": {
      "type": "array",
      "items": {
        "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"
          },
          "workspaceName": {
            "anyOf": [
              {
                "$ref": "#/$defs/ShortText"
              },
              {
                "type": "null"
              }
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "attaching",
              "attached",
              "detached",
              "failed"
            ]
          },
          "connectionId": {
            "anyOf": [
              {
                "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"
              },
              {
                "type": "null"
              }
            ]
          },
          "failureReason": {
            "anyOf": [
              {
                "$ref": "#/$defs/ShortText"
              },
              {
                "type": "null"
              }
            ]
          },
          "attachedAt": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "detachedAt": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "workspaceId",
          "workspaceName",
          "state",
          "connectionId",
          "failureReason",
          "attachedAt",
          "detachedAt"
        ],
        "patternProperties": {
          "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false
        },
        "additionalProperties": true,
        "propertyNames": {
          "type": "string",
          "enum": [
            "workspaceId",
            "workspaceName",
            "state",
            "connectionId",
            "failureReason",
            "attachedAt",
            "detachedAt"
          ]
        }
      },
      "maxItems": 500
    }
  },
  "required": [
    "id",
    "adapter",
    "provider",
    "displayName",
    "role",
    "sourceWorkspaceId",
    "sourceWorkspaceName",
    "sourceConnectionId",
    "sourceConnected",
    "includeFutureWorkspaces",
    "createdAt",
    "revokedAt",
    "targets"
  ],
  "patternProperties": {
    "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "id",
      "adapter",
      "provider",
      "displayName",
      "role",
      "sourceWorkspaceId",
      "sourceWorkspaceName",
      "sourceConnectionId",
      "sourceConnected",
      "includeFutureWorkspaces",
      "createdAt",
      "revokedAt",
      "targets"
    ]
  },
  "$defs": {
    "IntegrationShareAdapter": {
      "type": "string",
      "enum": [
        "apollo",
        "prospeo",
        "conductor",
        "mxtoolbox",
        "clay",
        "floqer",
        "heyreach",
        "getleads",
        "plusvibe",
        "calendly",
        "cal_com",
        "attio",
        "email_verifier",
        "phone_verifier",
        "warmup_provider",
        "mcp_server",
        "app_connection"
      ]
    },
    "ShortText": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    }
  }
}
```

### Underlying API operations

- `integrationShares.update`: `PATCH /v1/workspaces/:workspaceId/integration-shares/:shareId`