Update Organization Membership

$ nirvana organizations:memberships update

PATCH/v1/organizations/{organization_id}/memberships/{membership_id}

Change the role of a member of an organization. Owners may assign any role. Admins may assign admin, billing or member, and cannot change the role of an owner. The last owner cannot be demoted, and members cannot change their own role except for an owner stepping down while another owner remains.

ParametersExpand Collapse

--organization-id: string

Organization ID

--membership-id: string

Membership ID

--role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

ReturnsExpand Collapse

organization_membership: object { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "admin" or "billing" or "member"

Role of the user in the organization.

"owner"

"admin"

"billing"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

Update Organization Membership

nirvana organizations:memberships update \
  --api-key 'My API Key' \
  --organization-id organization_id \
  --membership-id membership_id \
  --role owner

{
  "id": "987e6543-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "role": "owner",
  "updated_at": "2025-01-01T00:00:00Z",
  "user_id": "456e7890-e89b-12d3-a456-426614174000"
}

Returns Examples

{
  "id": "987e6543-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "role": "owner",
  "updated_at": "2025-01-01T00:00:00Z",
  "user_id": "456e7890-e89b-12d3-a456-426614174000"
}