manage_collaborator

Invite, change the role of, or cancel a pending invite for a model collaborator. Requires Owner role on the model for every action. action selects the operation and which other fields are required: ‘invite’ takes email (and optional role, default ‘viewer’ — Requires Pro plan); ‘set_role’ takes target_user_id and role, and cannot demote the only model owner; ‘cancel_invite’ takes invite_id, the grant_id returned by a prior ‘invite’ call.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model. Caller must have Owner role.')]	Yes	—
action	Annotated[Literal['invite', 'set_role', 'cancel_invite'], Field(description='Which collaborator action to perform: invite, set_role, or cancel_invite.')]	Yes	—
email	`Annotated[str	None, Field(description=“Email address of the user to invite. Required for action=‘invite’.”)]`	No	None
role	`Annotated[Literal[‘owner’, ‘editor’, ‘viewer’]	None, Field(description=“Model role to grant. Required for action=‘set_role’; optional for action=‘invite’ (default: viewer).”)]`	No	None
target_user_id	`Annotated[str	None, Field(description=“UUID of the collaborator whose role to change. Required for action=‘set_role’.”)]`	No	None
invite_id	`Annotated[str	None, Field(description=“UUID of the pending invite to cancel. Required for action=‘cancel_invite’.”)]`	No	None
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• grant_id (string)
• model (string)
• action (string)
• email (string)
• role (string)
• pending (boolean)
• workspace_invite (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "manage_collaborator",
  "arguments": {
    "model_name": "forecasts",
    "action": "invite",
    "email": "carol@example.com",
    "role": "editor"
  }
}

Response

{
  "grant_id": "99999999-9999-9999-9999-999999999999",
  "model": "forecasts",
  "action": "invite",
  "email": "carol@example.com",
  "role": "editor",
  "pending": true,
  "workspace_invite": "created"
}

Notes

• Module: Collaborators
• Requires authentication via API token or Auth0 JWT.