# Batch create members

POST //localhost:8080/api/v1/members/batch
Content-Type: application/json

Create up to 50 members. Each gets a VK. Returns succeeded/failed arrays.

Reference: https://api.alephant.io/api-reference/saa-s-api/members/batch-create-members

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/members/batch:
    post:
      operationId: batch-create-members
      summary: Batch create members
      description: >-
        Create up to 50 members. Each gets a VK. Returns succeeded/failed
        arrays.
      tags:
        - subpackage_members
      parameters:
        - name: Authorization
          in: header
          description: Bearer {access_token}
          required: true
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: Workspace UUID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal_api_handlers_members.BatchCreateMembersResponse
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '401':
          description: AUTH_TOKEN_EXPIRED
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '422':
          description: VALIDATION_ERROR (e.g. batch size > 50)
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
      requestBody:
        description: members array
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/internal_api_handlers_members.BatchCreateMembersRequest
servers:
  - url: //localhost:8080
components:
  schemas:
    internal_api_handlers_members.CreateMemberRequest:
      type: object
      properties:
        departmentId:
          type: string
        displayName:
          type: string
        email:
          type: string
        expiresAt:
          type: string
        masterKeyId:
          type: string
        monthlyBudget:
          type: number
          format: double
        note:
          type: string
        rateLimitRpm:
          type: integer
        roleLabel:
          type: string
      required:
        - displayName
        - email
        - masterKeyId
      title: internal_api_handlers_members.CreateMemberRequest
    internal_api_handlers_members.BatchCreateMembersRequest:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: >-
              #/components/schemas/internal_api_handlers_members.CreateMemberRequest
      required:
        - members
      title: internal_api_handlers_members.BatchCreateMembersRequest
    internal_api_handlers_members.BatchFailedItem:
      type: object
      properties:
        index:
          type: integer
        reason:
          type: string
      title: internal_api_handlers_members.BatchFailedItem
    internal_api_handlers_members.CreateMemberResponseMember:
      type: object
      properties:
        createdAt:
          type: string
        email:
          type: string
        id:
          type: string
        name:
          type: string
        status:
          type: string
      title: internal_api_handlers_members.CreateMemberResponseMember
    internal_api_handlers_members.CreateMemberResponseVirtualKey:
      type: object
      properties:
        fullToken:
          type: string
        id:
          type: string
        keyPrefix:
          type: string
      title: internal_api_handlers_members.CreateMemberResponseVirtualKey
    internal_api_handlers_members.CreateMemberResponse:
      type: object
      properties:
        member:
          $ref: >-
            #/components/schemas/internal_api_handlers_members.CreateMemberResponseMember
        virtualKey:
          $ref: >-
            #/components/schemas/internal_api_handlers_members.CreateMemberResponseVirtualKey
      title: internal_api_handlers_members.CreateMemberResponse
    internal_api_handlers_members.BatchCreateMembersResponseData:
      type: object
      properties:
        failed:
          type: array
          items:
            $ref: '#/components/schemas/internal_api_handlers_members.BatchFailedItem'
        succeeded:
          type: array
          items:
            $ref: >-
              #/components/schemas/internal_api_handlers_members.CreateMemberResponse
      title: internal_api_handlers_members.BatchCreateMembersResponseData
    internal_api_handlers_members.BatchCreateMembersResponseMeta:
      type: object
      properties:
        failCount:
          type: integer
        successCount:
          type: integer
        total:
          type: integer
      title: internal_api_handlers_members.BatchCreateMembersResponseMeta
    internal_api_handlers_members.BatchCreateMembersResponse:
      type: object
      properties:
        data:
          $ref: >-
            #/components/schemas/internal_api_handlers_members.BatchCreateMembersResponseData
        meta:
          $ref: >-
            #/components/schemas/internal_api_handlers_members.BatchCreateMembersResponseMeta
      title: internal_api_handlers_members.BatchCreateMembersResponse

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/members/batch"

payload = { "members": [
        {
            "displayName": "string",
            "email": "string",
            "masterKeyId": "string"
        }
    ] }
headers = {
    "Authorization": "Authorization",
    "X-Workspace-Id": "X-Workspace-Id",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/members/batch';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Authorization',
    'X-Workspace-Id': 'X-Workspace-Id',
    'Content-Type': 'application/json'
  },
  body: '{"members":[{"displayName":"string","email":"string","masterKeyId":"string"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:8080/api/v1/members/batch"

	payload := strings.NewReader("{\n  \"members\": [\n    {\n      \"displayName\": \"string\",\n      \"email\": \"string\",\n      \"masterKeyId\": \"string\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Authorization")
	req.Header.Add("X-Workspace-Id", "X-Workspace-Id")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:8080/api/v1/members/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Authorization'
request["X-Workspace-Id"] = 'X-Workspace-Id'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"members\": [\n    {\n      \"displayName\": \"string\",\n      \"email\": \"string\",\n      \"masterKeyId\": \"string\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://localhost:8080/api/v1/members/batch")
  .header("Authorization", "Authorization")
  .header("X-Workspace-Id", "X-Workspace-Id")
  .header("Content-Type", "application/json")
  .body("{\n  \"members\": [\n    {\n      \"displayName\": \"string\",\n      \"email\": \"string\",\n      \"masterKeyId\": \"string\"\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://localhost:8080/api/v1/members/batch', [
  'body' => '{
  "members": [
    {
      "displayName": "string",
      "email": "string",
      "masterKeyId": "string"
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Authorization',
    'Content-Type' => 'application/json',
    'X-Workspace-Id' => 'X-Workspace-Id',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/members/batch");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Authorization");
request.AddHeader("X-Workspace-Id", "X-Workspace-Id");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"members\": [\n    {\n      \"displayName\": \"string\",\n      \"email\": \"string\",\n      \"masterKeyId\": \"string\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Authorization",
  "X-Workspace-Id": "X-Workspace-Id",
  "Content-Type": "application/json"
]
let parameters = ["members": [
    [
      "displayName": "string",
      "email": "string",
      "masterKeyId": "string"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/members/batch")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```