Skip to main content
PATCH
/
v1
/
groups
/
{id}
/
members
/
{participantId}
Update member role
curl --request PATCH \
  --url https://api.scrip.dev/v1/groups/{id}/members/{participantId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "role": "ADMIN",
  "on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
'
import requests

url = "https://api.scrip.dev/v1/groups/{id}/members/{participantId}"

payload = {
"role": "ADMIN",
"on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440001"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role: 'ADMIN',
on_behalf_of_participant_id: '550e8400-e29b-41d4-a716-446655440001'
})
};

fetch('https://api.scrip.dev/v1/groups/{id}/members/{participantId}', 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.scrip.dev/v1/groups/{id}/members/{participantId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'role' => 'ADMIN',
'on_behalf_of_participant_id' => '550e8400-e29b-41d4-a716-446655440001'
]),
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.scrip.dev/v1/groups/{id}/members/{participantId}"

payload := strings.NewReader("{\n \"role\": \"ADMIN\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.scrip.dev/v1/groups/{id}/members/{participantId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"ADMIN\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/groups/{id}/members/{participantId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role\": \"ADMIN\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Member role updated",
  "participant_id": "550e8400-e29b-41d4-a716-446655440000",
  "role": "ADMIN"
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "not_found",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource not found"
}
{
"code": "conflict",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource already exists or state conflict"
}
{
"code": "unsupported_media_type",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Content-Type must be application/json"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Updates a member’s role within a group. Valid roles are MEMBER and ADMIN. A group must always have at least one ADMIN. Attempting to demote the last admin returns an error.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

participantId
string<uuid>
required

Participant ID

Body

application/json

New role

role
enum<string>
required

New role for the member: MEMBER or ADMIN

Available options:
MEMBER,
ADMIN
Example:

"ADMIN"

on_behalf_of_participant_id
string<uuid>

Participant who initiated this change, for audit purposes

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

Member role updated

message
string

Confirmation message

Example:

"Member role updated"

participant_id
string<uuid>

Participant whose role was updated

Example:

"550e8400-e29b-41d4-a716-446655440000"

role
string

New role after update

Example:

"ADMIN"