Squads.Members

Overview

Available Operations

• update - Update Squad Member

update

This endpoint is used to update a squad member's role and is only accessible if your organization is using the OBAC permission model.

If you're attempting to update a member's role from 'owner' to 'member', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote the member to the role of owner.

Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.members.update(squad_id="<id>", member_id="<id>", replace_with="<value>", role="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
squad_id	str	✔️	N/A
member_id	str	✔️	N/A
replace_with	str	✔️	N/A
role	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.V4SquadsUpdateSquadMemberResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*