---
title: "Modify organization membership"
method: PATCH
path: "/v1/organization/members"
tags: ["Organizations"]
---

# Modify organization membership

`PATCH /v1/organization/members`

Modify organization membership

## Request body

- PatchOrganizationMembers
  - `invite_users` object, nullable — Users to invite to the organization
    - `ids` string[], nullable — Ids of existing users to invite
    - `emails` string[], nullable — Emails of users to invite
    - `send_invite_emails` boolean, nullable — If true, send invite emails to the users who wore actually added
    - `group_ids` string[], nullable — Optional list of group ids to add newly-invited users to.
    - `group_names` string[], nullable — Optional list of group names to add newly-invited users to.
    - `group_id` string, uuid, nullable — Singular form of group_ids
    - `group_name` string, nullable — Singular form of group_names
  - `remove_users` object, nullable — Users to remove from the organization
    - `ids` string[], nullable — Ids of users to remove
    - `emails` string[], nullable — Emails of users to remove
  - `org_name` string, nullable — For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, or in case you want to explicitly assert the organization you are modifying, you may specify the name of the organization.
  - `org_id` string, nullable — For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, or in case you want to explicitly assert the organization you are modifying, you may specify the id of the organization.

## Response `200`

A success status

- PatchOrganizationMembersOutput
  - `status` 'success', required
  - `send_email_error` string, nullable — If invite emails failed to send for some reason, the patch operation will still complete, but we will return an error message here

## Other responses

- `400` — The request was unacceptable, often due to missing a required parameter
- `401` — No valid API key provided
- `403` — The API key doesn’t have permissions to perform the request
- `429` — Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
- `500` — Something went wrong on Braintrust's end. (These are rare.)

---

[API](https://skmtc.net/braintrustdata/apis/braintrust-api.md) · [All operations](https://skmtc.net/braintrustdata/apis/braintrust-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/braintrustdata/braintrust-api/revisions/9d216c8243fe/schema)