Skip to content

remove_model_collaborator

Remove an active collaborator from a model using their target_user_id. Requires Owner role on the model. To cancel a pending invite instead, use cancel_model_invite with the invite_id (grant_id) returned by invite_model_collaborator. Cannot remove the only model owner. Returns: model, user_id, removed (bool).

destructive

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model. Caller must have Owner role.')]Yes
target_user_idAnnotated[str, Field(description='UUID of the collaborator whose role or access to change.')]Yes

Returns a structured object. Top-level fields:

  • model (string)
  • user_id (string)
  • removed (boolean)

See the response example below for the full payload shape.

{
"name": "remove_model_collaborator",
"arguments": {
"model_name": "forecasts",
"target_user_id": "33333333-3333-3333-3333-333333333333"
}
}
{
"model": "forecasts",
"user_id": "33333333-3333-3333-3333-333333333333",
"removed": true
}
  • Module: Collaborators
  • Requires authentication via API token or Auth0 JWT.