Create Member - Dawn Documentation

Create Member

curl --request POST \
  --url https://api.example.com/organisations/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "create_group": {
    "name": "<string>",
    "folder_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "file_ids": [
      {}
    ]
  }
}
'

import requests

url = "https://api.example.com/organisations/members"

payload = {
    "name": "<string>",
    "email": "<string>",
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "create_group": {
        "name": "<string>",
        "folder_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "file_ids": [{}]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    email: '<string>',
    role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    create_group: {
      name: '<string>',
      folder_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      file_ids: [{}]
    }
  })
};

fetch('https://api.example.com/organisations/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/organisations/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'email' => '<string>',
    'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'create_group' => [
        'name' => '<string>',
        'folder_ids' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'file_ids' => [
                [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/organisations/members"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/organisations/members")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organisations/members")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

organisations

members

Create Member

curl --request POST \
  --url https://api.example.com/organisations/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "create_group": {
    "name": "<string>",
    "folder_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "file_ids": [
      {}
    ]
  }
}
'

import requests

url = "https://api.example.com/organisations/members"

payload = {
    "name": "<string>",
    "email": "<string>",
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "create_group": {
        "name": "<string>",
        "folder_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "file_ids": [{}]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    email: '<string>',
    role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    create_group: {
      name: '<string>',
      folder_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      file_ids: [{}]
    }
  })
};

fetch('https://api.example.com/organisations/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/organisations/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'email' => '<string>',
    'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'create_group' => [
        'name' => '<string>',
        'folder_ids' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'file_ids' => [
                [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/organisations/members"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/organisations/members")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organisations/members")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"create_group\": {\n    \"name\": \"<string>\",\n    \"folder_ids\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"file_ids\": [\n      {}\n    ]\n  }\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key

string | null

Body

application/json

name

string

required

string

required

role_id

string<uuid> | null

group_id

string<uuid> | null

create_group

MemberGroupCreateRequest · object | null

Show child attributes

Response

Successful Response