ban_user

Bans users from a group. This works even if the users aren’t in the group. If they are currently in the group, they will also be removed.

auto-generated example may not be a valid request. See v1.BanUserRequest for all fields.

{
    "account": "0cc10e61-d64c-4dbc-b51c-334f7dd45a4a",
    "group_id": "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=",
    "type": "ban_user",
    "users": [
        {
            "number": "+13215551234"
        }
    ],
    "version": "v1"
}

• Request Type: v1.BanUserRequest
• Success Response Type: v1.JsonGroupV2Info
• Error response types:
  • v1.NoSuchAccountError
  • v1.ServerNotFoundError
  • v1.InvalidProxyError
  • v1.UnknownGroupError
  • v1.GroupVerificationError
  • v1.InternalError
  • v1.InvalidRequestError
  • v1.AuthorizationFailedError - Can be caused if signald is setup as a linked device that has been removed by the primary device. If trying to update a group, this can also be caused if group permissions don’t allow the update (e.g. current role insufficient or not a member).
  • v1.SQLError
  • v1.GroupPatchNotAcceptedError - Caused when server rejects the group update.