Update

client.teams.members.update(, , ?): MemberUpdateResponse

PUT/teams/{teamId}/members/{memberId}

Update a team member’s role and/or consumption limit

ParametersExpand Collapse

memberID: string

params: MemberUpdateParams { teamId, maxConsumption, role }

teamId: string

Path param: The team Id the member belongs to

maxConsumption?: number

Body param: Max consumption (CU) for this member over the billing period, overriding the team-wide default. Use a value >= 0 to cap, -1 for unlimited (uncapped), or null to remove the override and fall back to the team-wide default.

role?: string

Body param: For a human member: a built-in team role (admin | member). For an API-key member: a team-plane role — a ;-separated list of team.* scopes (e.g. "team.members.manage;team.usage.read"). Only a human team admin can grant a write scope; team.members.manage also lets a team key manage the members, API keys and consumption cap of every project of the team.

ReturnsExpand Collapse

MemberUpdateResponse = unknown

Update

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const member = await client.teams.members.update('memberId', { teamId: 'teamId' });

console.log(member);

{}

Returns Examples

{}