> ## Documentation Index > Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Modify account members > > For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt). > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles). - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersRoles", "value": "reader", "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{"never": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceAllMembersRoles", "value": "reader", "filterLastSeen": { "never": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersCustomRoles", "values": [ "example-custom-role" ], "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{"never": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceAllMembersCustomRoles", "values": [ "example-custom-role" ], "filterLastSeen": { "never": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersRoleAttributes", "value": { "myRoleProjectKey": ["mobile", "web"], "myRoleEnvironmentKey": ["production"] }, "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ```
## OpenAPI ````yaml /openapi/launchdarkly-api.json patch /api/v2/members openapi: 3.0.3 info: title: LaunchDarkly REST API description: > > For the complete documentation index, see https://launchdarkly-preview.mintlify.app/llms.txt. > For the full documentation snapshot, see https://launchdarkly-preview.mintlify.app/llms-full.txt. This is the LaunchDarkly REST API. It lets you build custom integrations, automate your workflow, and manage feature flags and other LaunchDarkly resources programmatically. For authentication, rate limits, pagination, versioning, JSON Patch and semantic patches, beta resources, and the full SDK End-of-Life table, read the [REST API overview](https://launchdarkly-preview.mintlify.app/api). To fetch the complete OpenAPI spec, use [Get OpenAPI spec](https://launchdarkly.com/docs/api/other/get-openapi-spec). contact: name: LaunchDarkly Technical Support Team url: https://support.launchdarkly.com email: support@launchdarkly.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: '2.0' servers: - url: https://app.launchdarkly.com description: ' Default' - url: https://app.launchdarkly.us description: ' Federal' security: - ApiKey: - read - write tags: - name: Access tokens description: >- The access tokens API allows you to list, create, modify, and delete access tokens programmatically. - name: Account members description: >- The account members API allows you to invite new members to an account by making a `POST` request to `/api/v2/members`. When you invite a new member to an account, an invitation is sent to the email you provided. - name: Account usage (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: AI Configs description: >- The AI Configs API allows you to create, retrieve, and edit AI Configs, AI Config variations, and AI model configurations. - name: Announcements description: >- The announcements API lets you create and update a custom announcement banner that appears in the LaunchDarkly user interface for everyone in your organization. - name: Applications (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Approvals description: >- An account member can request approval on changes to a flag or AI Config's targeting or variations, or to a segment's targeting. Members may be required to request approval depending on the settings in their LaunchDarkly project. - name: Approvals (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Audit log description: >- LaunchDarkly maintains a record of all the changes made to any resource in the system. You can access this history using the audit log API, including filtering by timestamps, or using a custom policy to select which entries to receive. - name: Code references description: >- > ### Code references is an Enterprise feature > > Code references is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Context settings description: >- You can use the context settings API to assign a context to a specific variation for any feature flag. To learn more, read [View and manage contexts](https://launchdarkly.com/docs/home/observability/context-attributes#view-and-manage-contexts). - name: Contexts description: >- Contexts are people, services, machines, or other resources that encounter feature flags in your product. Contexts are identified by their `kind`, which describes the type of resources encountering flags, and by their `key`. - name: Custom roles description: >- > ### Custom roles is an Enterprise feature > > Custom roles is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Data Export destinations description: >- > ### Data Export is an add-on feature > > Data Export is available as an add-on for customers on a Foundation or Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Environments description: >- Environments allow you to maintain separate rollout rules in different contexts, from local development to QA, staging, and production. With the LaunchDarkly Environments API, you can programmatically list, create, and manage environments. - name: Experiments description: >- > ### Available for subscription customers > > Experimentation is available to all customers on a Developer, Foundation, or Enterprise subscription. If you're on an older Pro or Enterprise plan, Experimentation is available as an add-on. - name: Feature flags description: >- The feature flags API allows you to list, create, and modify feature flags and their targeting. For example, you can control percentage rollouts, target specific contexts, or even toggle off a feature flag programmatically. - name: Feature flags (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Flag import configurations (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Flag links (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Flag triggers description: >- > ### Flag triggers is an Enterprise feature > > Flag triggers is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Follow flags description: >- Follow flags to receive email updates about targeting changes to a flag in a project and environment. - name: Holdouts (beta) description: >- > ### Available for customers using Experimentation > > Holdouts are available to customers using [Experimentation](https://launchdarkly.com/docs/api/experiments). - name: Insights charts (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Insights deployments (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Insights flag events (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Insights pull requests (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Insights repositories (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Insights scores (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Integration audit log subscriptions description: >- Audit log integration subscriptions allow you to send audit log events hooks to one of dozens of external tools. For example, you can send flag change event webhooks to external third party software. - name: Integration delivery configurations (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Integrations (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Layers description: >- > ### Available for customers using Experimentation > > Layers are available to customers using [Experimentation](https://launchdarkly.com/docs/api/experiments). - name: Metrics description: >- Metrics track flag behavior over time when an experiment is running. The data generated from experiments gives you more insight into the impact of a particular flag. - name: Metrics (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: OAuth2 Clients description: >- The OAuth2 client API allows you to register a LaunchDarkly OAuth client for use in your own custom integrations. - name: Persistent store integrations (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Projects description: >- Projects allow you to manage multiple different software projects under one LaunchDarkly account. Each project has its own unique set of environments and feature flags. - name: Relay Proxy configurations description: >- > ### Relay Proxy automatic configuration is an Enterprise feature > > Relay Proxy automatic configuration is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Release pipelines (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Release policies (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Releases (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Scheduled changes description: >- > ### Scheduled flag changes is an Enterprise feature > > Scheduled flag changes is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Segments description: >- > ### Synced segments and larger list-based segments are an Enterprise feature > > This section documents endpoints for rule-based, list-based, and synced segments. - name: Tags description: >- Tags are simple strings that you can attach to most resources in LaunchDarkly. Tags are useful for grouping resources into a set that you can name in a resource specifier. - name: Teams description: >- > ### Teams is an Enterprise feature > > Teams is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). - name: Teams (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: User settings description: >- > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Contexts](https://launchdarkly.com/docs/api/contexts) instead of the user settings API. - name: Users description: >- > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Contexts](https://launchdarkly.com/docs/api/contexts) instead of these endpoints. - name: Users (beta) description: >- > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Contexts](https://launchdarkly.com/docs/api/contexts) instead of these endpoints. - name: Views (beta) description: >- > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. - name: Webhooks description: >- The webhooks API lets you build your own integrations that subscribe to activities in LaunchDarkly. When you generate an activity in LaunchDarkly, such as when you change a flag or you create a project, LaunchDarkly sends an HTTP POST payload to the... - name: Workflow templates description: >- > ### Workflows are in maintenance mode > > The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. - name: Workflows description: >- > ### Workflows are in maintenance mode > > The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. - name: Other description: Other requests available in the LaunchDarkly API. paths: /api/v2/members: patch: tags: - Account members summary: Modify account members description: > > For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt). > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles). - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersRoles", "value": "reader", "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{"never": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceAllMembersRoles", "value": "reader", "filterLastSeen": { "never": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersCustomRoles", "values": [ "example-custom-role" ], "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{"never": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceAllMembersCustomRoles", "values": [ "example-custom-role" ], "filterLastSeen": { "never": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { "instructions": [{ "kind": "replaceMembersRoleAttributes", "value": { "myRoleProjectKey": ["mobile", "web"], "myRoleEnvironmentKey": ["production"] }, "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ] }] } ```
operationId: patchMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/membersPatchInput' example: comment: Optional comment about the update instructions: - kind: replaceMembersRoles memberIDs: - 1234a56b7c89d012345e678f - 507f1f77bcf86cd799439011 value: reader required: true responses: '200': description: Members response content: application/json: schema: $ref: '#/components/schemas/BulkEditMembersRep' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/InvalidRequestErrorRep' '401': description: Invalid access token content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorRep' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorRep' '409': description: Status conflict content: application/json: schema: $ref: '#/components/schemas/StatusConflictErrorRep' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/RateLimitedErrorRep' components: schemas: membersPatchInput: type: object required: - instructions properties: comment: type: string description: Optional comment describing the update example: Optional comment about the update instructions: $ref: '#/components/schemas/Instructions' description: >- The instructions to perform when updating. This should be an array with objects that look like {"kind": "update_action"}. Some instructions also require additional parameters as part of this object. example: '[ { "kind": "replaceMembersRoles", "value": "reader" } ]' BulkEditMembersRep: type: object properties: members: type: array description: A list of members IDs of the members who were successfully updated. items: type: string example: - 1234a56b7c89d012345e678f errors: type: array description: >- A list of member IDs and errors for the members whose updates failed. items: type: object additionalProperties: type: string example: - 507f1f77bcf86cd799439011: you cannot modify your own role InvalidRequestErrorRep: type: object required: - code - message properties: code: type: string description: Specific error code encountered example: invalid_request message: type: string description: Description of the error example: Invalid request body UnauthorizedErrorRep: type: object required: - code - message properties: code: type: string description: Specific error code encountered example: unauthorized message: type: string description: Description of the error example: Invalid access token ForbiddenErrorRep: type: object required: - code - message properties: code: type: string description: Specific error code encountered example: forbidden message: type: string description: Description of the error example: Forbidden. Access to the requested resource was denied. StatusConflictErrorRep: type: object required: - code - message properties: code: type: string description: Specific error code encountered example: optimistic_locking_error message: type: string description: Description of the error example: Conflict. Optimistic lock error. Try again later. RateLimitedErrorRep: type: object required: - code - message properties: code: type: string description: Specific error code encountered example: rate_limited message: type: string description: Description of the error example: You've exceeded the API rate limit. Try again later. Instructions: type: array items: $ref: '#/components/schemas/Instruction' Instruction: type: object additionalProperties: {} securitySchemes: ApiKey: type: apiKey in: header name: Authorization ````