Update

Updates a given role.

PUT /roles/{role}

Update

cURL

curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/roles/{role} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "",
  "description": "",
  "metadata": {
    "email": "[e-mail]"
  },
  "unset": [],
  "settings": []
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/roles/{role}"

payload = {
    "name": "",
    "description": "",
    "metadata": { "email": "[e-mail]" },
    "unset": [],
    "settings": []
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '',
    description: '',
    metadata: {email: '[e-mail]'},
    unset: [],
    settings: []
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/roles/{role}', 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://{appId}.api-{region}.cometchat.io/v3/roles/{role}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '',
    'description' => '',
    'metadata' => [
        'email' => '[e-mail]'
    ],
    'unset' => [
        
    ],
    'settings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <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://{appId}.api-{region}.cometchat.io/v3/roles/{role}"

	payload := strings.NewReader("{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"metadata\": {\n    \"email\": \"[e-mail]\"\n  },\n  \"unset\": [],\n  \"settings\": []\n}")

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

	req.Header.Add("apikey", "<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.put("https://{appId}.api-{region}.cometchat.io/v3/roles/{role}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"metadata\": {\n    \"email\": \"[e-mail]\"\n  },\n  \"unset\": [],\n  \"settings\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/roles/{role}")

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

request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"metadata\": {\n    \"email\": \"[e-mail]\"\n  },\n  \"unset\": [],\n  \"settings\": []\n}"

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

200

{
  "data": {
    "role": "manager",
    "name": "manager",
    "description": "This role gives an update access",
    "metadata": {
      "email": "[e-mail]"
    },
    "settings": {
      "listUsers": "all",
      "sendMessagesTo": "friendsOnly"
    },
    "createdAt": 1638343994
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

role · string · required

A role to update.

Body

application/json

name · string · default: ""

Friendly name of the role.

description · string · default: ""

Description of the role.

metadata · object

Additional information about the role.

unset · enum<string>[]

The unsettable role attributes are settings, description and metadata.

Group attributes that can be unset.

Available options: settings, description, metadata

settings · object

Role settings that is used for restricting list users/send message. Possible values for listUsers & sendMessagesTo are all and friendsOnly

Response

200 - application/json

Updated Role

data · object