Docs
Team

Change a member's role or switch them off

PATCHhttps://api.norreach.app/v1/members/{id}

Sets role (caller, manager or admin — never owner) and/or active (false switches them off: they can't use the workspace, and API keys they created stop working at once; true switches them back on). Owners and admins, with the team:admin scope. Refused with 403 member_locked (reason): the key's creator's own row (own_row), the workspace's owner (workspace_owner), or someone above the creator's role / a role above it (above_your_role). Nothing is deleted.

⚠ team:adminRole must allow: team.rolesIdempotency-Key requiredSupports dry_runOperation id: update_member
PATCH/members/{id}
curl -X PATCH "https://api.norreach.app/v1/members/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "active": false
}'
Change a member's role or switch them off
{
  "id": "3b2a1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
  "object": "member",
  "name": "Alex Andersson",
  "email": "alex@acme.example",
  "role": "manager",
  "active": false,
  "is_owner": false,
  "joined_at": "2026-09-14T08:30:00.000Z",
  "changed": true,
  "dry_run": false,
  "note": "Switched off: they can't use the workspace any more, and API keys they created stop working."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope team:admin. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

roleenum

The role to give: caller, manager or admin (never owner).

One of:callermanageradmin
activeboolean

false switches them off, true back on.

Response

200application/json— Change a member's role or switch them off

idstring (uuid)required

An id (UUID).

object"member"required
namestring | nullrequired
emailstring | nullrequired
roleenumrequired

owner > admin > manager > caller.

One of:owneradminmanagercaller
activebooleanrequired

false = switched off: they (and API keys they created) can't use the workspace.

is_ownerbooleanrequired

The workspace's owner — never changed through the API.

joined_atstring | nullrequired

When they were added (invited people: when the invite went out).

changedbooleanrequired
dry_runbooleanrequired
notestringrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
400idempotency_key_requiredThis operation needs an Idempotency-Key header.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403member_lockedThis person's role or access can't be changed this way.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.