Skip to content

remove_model_collaborator

Remove an active collaborator from a model using the grant_id returned by list_model_collaborators. Requires Owner role on the model. To cancel a pending invite instead, use manage_collaborator with action=‘cancel_invite’ and the grant_id returned by manage_collaborator’s action=‘invite’. Cannot remove the only model owner.

destructive

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model. Caller must have Owner role.')]Yes
grant_idAnnotated[str, Field(description='Opaque collaborator grant identifier returned by list_model_collaborators.')]Yes
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model (string)
  • removed (boolean)

See the response example below for the full payload shape.

{
"name": "remove_model_collaborator",
"arguments": {
"model_name": "forecasts",
"grant_id": "99999999-9999-9999-9999-999999999999"
}
}
{
"model": "forecasts",
"removed": true
}
  • Module: Collaborators
  • Requires an authenticated Bridge Town session (OAuth) or an API token.