Update project member

http
PATCH /projects/{project_reference}/members/{user_id}

Changes a non-owner member's role to admin, editor or viewer; the owner changes only through updateProjectOwner. Requires project.members.manage.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.
user_idpathYesUser ID of the project member.

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "format": "uuid",
      "description": "User ID of the project member."
    },
    "required": true,
    "description": "User ID of the project member.",
    "name": "user_id",
    "in": "path"
  }
]

Request body

json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "enum": [
              "admin",
              "editor",
              "viewer"
            ],
            "description": "New role: admin, editor or viewer. Owner promotion uses updateProjectOwner."
          }
        },
        "required": [
          "role"
        ]
      }
    }
  }
}

Responses

200

The member with the new role

json
{
  "description": "The member with the new role",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string",
            "format": "uuid",
            "description": "User ID of the project member."
          },
          "email": {
            "type": "string",
            "description": "Email address of the member."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Display name of the member; null when the member has none."
          },
          "avatar_src": {
            "type": [
              "string",
              "null"
            ],
            "description": "Avatar URL of the member; null when the member has none."
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "admin",
              "editor",
              "viewer"
            ],
            "description": "Project role of the member: owner, admin, editor or viewer."
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "project.read",
                "project.settings.manage",
                "project.delete",
                "project.members.read",
                "project.members.manage",
                "project.invites.read",
                "project.invites.manage",
                "project.files.read",
                "project.files.write",
                "project.realtime.connect",
                "project.realtime.write",
                "project.files.admin",
                "project.uploads.read",
                "project.uploads.write",
                "project.uploads.admin",
                "project.knowledge.read",
                "project.knowledge.write",
                "project.releases.read",
                "project.releases.write",
                "project.deployments.read",
                "project.deployments.write",
                "project.deploy.execute",
                "project.runtime.manage",
                "project.channels.read",
                "project.channels.write",
                "project.sandboxes.manage",
                "project.domains.write",
                "project.environments.manage",
                "project.env_vars.write",
                "project.runs.read",
                "project.runs.write",
                "project.runs.admin",
                "project.agents.read",
                "project.agents.write",
                "project.evals.read",
                "project.evals.write",
                "project.evals.run",
                "project.conversations.read",
                "project.conversations.write",
                "project.conversations.create",
                "project.integrations.read",
                "project.integrations.connect",
                "project.integrations.configure",
                "project.api_keys.read",
                "project.api_keys.manage",
                "project.cache.read",
                "project.cache.write",
                "project.logs.read",
                "project.metrics.read",
                "project.resources.read"
              ]
            },
            "description": "Project capabilities the role grants, as the permission checks resolve them."
          }
        },
        "required": [
          "user_id",
          "email",
          "name",
          "avatar_src",
          "role",
          "capabilities"
        ]
      }
    }
  }
}

400

Invalid user ID or role, or the member is the current owner; use updateProjectOwner

json
{
  "description": "Invalid user ID or role, or the member is the current owner; use updateProjectOwner",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden - insufficient permissions, or the project is system-managed

json
{
  "description": "Forbidden - insufficient permissions, or the project is system-managed",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Project or member not found

json
{
  "description": "Project or member not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

413

Payload too large

json
{
  "description": "Payload too large",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

503

internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.

json
{
  "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "updateProjectMember",
  "tags": [
    "identity-access/Users/Project members"
  ],
  "summary": "Update project member",
  "description": "Changes a non-owner member's role to admin, editor or viewer; the owner changes only through updateProjectOwner. Requires project.members.manage.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string",
        "format": "uuid",
        "description": "User ID of the project member."
      },
      "required": true,
      "description": "User ID of the project member.",
      "name": "user_id",
      "in": "path"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "role": {
              "type": "string",
              "enum": [
                "admin",
                "editor",
                "viewer"
              ],
              "description": "New role: admin, editor or viewer. Owner promotion uses updateProjectOwner."
            }
          },
          "required": [
            "role"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "The member with the new role",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "user_id": {
                "type": "string",
                "format": "uuid",
                "description": "User ID of the project member."
              },
              "email": {
                "type": "string",
                "description": "Email address of the member."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Display name of the member; null when the member has none."
              },
              "avatar_src": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Avatar URL of the member; null when the member has none."
              },
              "role": {
                "type": "string",
                "enum": [
                  "owner",
                  "admin",
                  "editor",
                  "viewer"
                ],
                "description": "Project role of the member: owner, admin, editor or viewer."
              },
              "capabilities": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "project.read",
                    "project.settings.manage",
                    "project.delete",
                    "project.members.read",
                    "project.members.manage",
                    "project.invites.read",
                    "project.invites.manage",
                    "project.files.read",
                    "project.files.write",
                    "project.realtime.connect",
                    "project.realtime.write",
                    "project.files.admin",
                    "project.uploads.read",
                    "project.uploads.write",
                    "project.uploads.admin",
                    "project.knowledge.read",
                    "project.knowledge.write",
                    "project.releases.read",
                    "project.releases.write",
                    "project.deployments.read",
                    "project.deployments.write",
                    "project.deploy.execute",
                    "project.runtime.manage",
                    "project.channels.read",
                    "project.channels.write",
                    "project.sandboxes.manage",
                    "project.domains.write",
                    "project.environments.manage",
                    "project.env_vars.write",
                    "project.runs.read",
                    "project.runs.write",
                    "project.runs.admin",
                    "project.agents.read",
                    "project.agents.write",
                    "project.evals.read",
                    "project.evals.write",
                    "project.evals.run",
                    "project.conversations.read",
                    "project.conversations.write",
                    "project.conversations.create",
                    "project.integrations.read",
                    "project.integrations.connect",
                    "project.integrations.configure",
                    "project.api_keys.read",
                    "project.api_keys.manage",
                    "project.cache.read",
                    "project.cache.write",
                    "project.logs.read",
                    "project.metrics.read",
                    "project.resources.read"
                  ]
                },
                "description": "Project capabilities the role grants, as the permission checks resolve them."
              }
            },
            "required": [
              "user_id",
              "email",
              "name",
              "avatar_src",
              "role",
              "capabilities"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid user ID or role, or the member is the current owner; use updateProjectOwner",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - insufficient permissions, or the project is system-managed",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Project or member not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "413": {
      "description": "Payload too large",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "503": {
      "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project Members",
  "x-canonical-documentation": {
    "domain": "identity-access",
    "resource": "Users",
    "subgroup": "Project members",
    "name": "Update project member",
    "description": "Changes a non-owner member's role to admin, editor or viewer; the owner changes only through updateProjectOwner. Requires project.members.manage.",
    "operationId": "updateProjectMember"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/identity-access-users-project-members/update-project-member"
  }
}