Change the role or status of a Member

PATCH /v1/members/{member_id}

Applies the named fields at the revision If-Match names; disabled stops the Member signing in. From 1.51.0 a write that would leave the Organization without an owner (removing the only owner, demoting it to another role or disabling it) is refused with last_owner and one detail whose reason is a LastOwnerChange, and changes nothing. That rule is checked first; then a caller that is not an owner and removes, demotes or disables an owner is refused with forbidden and the detail owner_required, because only an owner changes an owner. From 1.34.0 a write that gives the operator role is refused with forbidden and the one detail operator_role_not_grantable, at path /role, in any Organization but the operator Organization, whoever asks, and there to any caller that does not hold the operator role; a write that keeps the role or takes it away is not a grant. Phase 0 accepts a Member ID token for this route, so an operator signed in to the cockpit makes the write.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the members:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/members/mem_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/members/mem_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/members/mem_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: MemberUpdateRequest.

Responses

Fields of the 200 answer

The shape is Member.