Invite new members
Invite one or more new members to join an account. Each member is sent an invitation. Members with Admin or Owner roles may create new members, as well as anyone with a `createMember` permission for "member/\*". If a member cannot be invited, the entire request is rejected and no members are invited from that request.
Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the "message" field of the response.
Valid base role names that you can provide for the `role` field include `reader`, `writer`, `admin`, `owner/admin`, and `no_access`. To learn more about base roles, read [Organization roles](https://launchdarkly.com/docs/home/account/roles/organization-roles).
If you are using the `customRoles` field instead, you can provide the key for any role that you have created, or for any preset [organization role](https://launchdarkly.com/docs/home/account/roles/organization-roles) or [project role](https://launchdarkly.com/docs/home/account/roles/project-roles) provided by LaunchDarkly. Some preset roles additionally require that you specify `roleAttributes`. To learn more, read [Using role scope](https://launchdarkly.com/docs/home/account/roles/role-scope).
Requests to create account members will not work if SCIM is enabled for the account.
_No more than 50 members may be created per request._
A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`:
- **email_already_exists_in_account**: A member with this email address already exists in this account.
- **email_taken_in_different_account**: A member with this email address exists in another account.
- **duplicate_email**s: This request contains two or more members with the same email address.
A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
Authentication
Authorizationstring
API Key authentication via header
Request
This endpoint expects a list of objects.
email
The member's email
password
The member's password
firstName
The member's first name
lastName
The member's last name
role
The member's initial role, if you are using a base role for the initial role
Allowed values:
customRoles
An array of the member's initial roles, if you are using custom roles or preset roles provided by LaunchDarkly
teamKeys
An array of the member's teams
roleAttributes
An object of role attributes for the member
Response
Member collection response
items
An array of members
_links
The location and content type of related resources
totalCount
The number of members returned
