Skip to main content
POST
/
roles
Create
curl --request POST \
  --url https://api.beyondwords.io/v1/roles \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "New role",
  "permissions": {
    "content_view": {
      "enabled": false
    },
    "content_create": {
      "enabled": false
    }
  }
}
'
import requests

url = "https://api.beyondwords.io/v1/roles"

payload = {
    "name": "New role",
    "permissions": {
        "content_view": { "enabled": False },
        "content_create": { "enabled": False }
    }
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'New role',
    permissions: {content_view: {enabled: false}, content_create: {enabled: false}}
  })
};

fetch('https://api.beyondwords.io/v1/roles', 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.beyondwords.io/v1/roles",
  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' => 'New role',
    'permissions' => [
        'content_view' => [
                'enabled' => false
        ],
        'content_create' => [
                'enabled' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$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.beyondwords.io/v1/roles"

	payload := strings.NewReader("{\n  \"name\": \"New role\",\n  \"permissions\": {\n    \"content_view\": {\n      \"enabled\": false\n    },\n    \"content_create\": {\n      \"enabled\": false\n    }\n  }\n}")

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

	req.Header.Add("X-Api-Key", "<api-key>")
	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.beyondwords.io/v1/roles")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"New role\",\n  \"permissions\": {\n    \"content_view\": {\n      \"enabled\": false\n    },\n    \"content_create\": {\n      \"enabled\": false\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/roles")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"New role\",\n  \"permissions\": {\n    \"content_view\": {\n      \"enabled\": false\n    },\n    \"content_create\": {\n      \"enabled\": false\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "key": "owner",
  "name": "Owner",
  "organization_id": 1,
  "permissions": {
    "content_view": {
      "enabled": true
    },
    "content_create": {
      "enabled": false
    }
  },
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
key
string
permissions
object | null

Response

201 - application/json

successful

id
integer
key
string
name
string
organization_id
integer
permissions
object | null
members_count
integer
created
string

Time at which the object was created (ISO 8601)

updated
string

Time at which the object was updated (ISO 8601)