Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Update role for organization member

Updates the role of an existing member in the specified organization.

PATCH /organizations/{org_id}/members/{member_id}

Updates the role of an existing member in the specified organization. The requested role must be valid for the organization. Only organization admins can call this endpoint.

Markdown for AI context

REST API - curl
curl "https://console.neon.tech/api/v2/organizations/$ORG_ID/members/$MEMBER_ID" \
  -X PATCH \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"member"}'

Also available in

TypeScript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateOrganizationMember({
  client: neon.client,
  path: {
    org_id: process.env.ORG_ID,
    member_id: process.env.MEMBER_ID
  },
  body: {
    role: "member"
  }
});

Console path: Organization → People → Members

Organization

org_id

string

The Neon organization ID

Member ID

member_id

string

The Neon organization member ID

1 required Required: role.

Role

role

string

Organization member's role. admin: full administrative access. editor (and its legacy alias member): standard access governed by project permissions. viewer and collaborator: additional scoped project roles. Some values may not be available for all organizations.

adminmembereditorviewercollaborator

200

The updated organization member

Depth

"id": (string),requuid

"user_id": (string),requuid

"org_id": (string),req

"role": (string),reqadmin | member | editor | viewer | collaborator

"joined_at": (string),date-time

default

General error

This endpoint can return the standard Neon API error response.

Response fields

  • message Required. Human-readable error message.
  • code Required. Machine-readable error code.
  • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu