Add files to your Postgres branches via Neon Object Storage, our S3-compatible object store
/APIs & SDKs/Projects/Set an org member's role on a project
PUT/projects/{project_id}/members/{member_id}/role

Set an org member's role on a project

Idempotently sets or updates the explicit project grant of the specified org member. Self-demotion requires confirm_self_demotion=true.

Markdown for AI context

Quick start

REST API - curl
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/members/$MEMBER_ID/role" \
  -X PUT \
  -H "Authorization: Bearer $NEON_API_KEY"
Also available in
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.setProjectMemberRole({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    member_id: process.env.MEMBER_ID
  }
});

Parameters

Project ID
project_id
string

Member ID
member_id
string

Confirm self demotion
confirm_self_demotion
boolean

Request body

1 required Required: role.

Role
role
string

Per-project role. viewer maps to VIEWER, editor maps to EDITOR, and admin maps to ADMIN.

viewereditoradmin

Response

200

Role set or updated

Depth
"project_id": (string),req
"member_id": (string),requuid
"user_id": (string),requuid
"org_role": (string),reqadmin | member | editor | viewer | collaborator
"name": (string),
"email": (string),email≥1 chars, ≤256 chars
"project_role": (string),viewer | editor | admin
"org_default_project_permission": (string),VIEWER | EDITOR | ADMIN
"explicit_project_permission": (string),VIEWER | EDITOR | ADMIN
"effective_project_permission": (string),VIEWER | EDITOR | ADMIN
"credential_rotation_recommended": (boolean),
"org_api_key_rotation_recommended": (boolean),

Errors

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.

Was this page helpful?

On this page

Copy neon init command