Add a member to a group
curl --request POST \
--url https://api.scrip.dev/v1/groups/{id}/members \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"participant_id": "550e8400-e29b-41d4-a716-446655440000",
"on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440010",
"role": "MEMBER"
}
'import requests
url = "https://api.scrip.dev/v1/groups/{id}/members"
payload = {
"participant_id": "550e8400-e29b-41d4-a716-446655440000",
"on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440010",
"role": "MEMBER"
}
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({
participant_id: '550e8400-e29b-41d4-a716-446655440000',
on_behalf_of_participant_id: '550e8400-e29b-41d4-a716-446655440010',
role: 'MEMBER'
})
};
fetch('https://api.scrip.dev/v1/groups/{id}/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.scrip.dev/v1/groups/{id}/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([
'participant_id' => '550e8400-e29b-41d4-a716-446655440000',
'on_behalf_of_participant_id' => '550e8400-e29b-41d4-a716-446655440010',
'role' => 'MEMBER'
]),
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"
payload := strings.NewReader("{\n \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\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.scrip.dev/v1/groups/{id}/members")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/groups/{id}/members")
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 \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Member(s) added to group"
}{
"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": "forbidden",
"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": "Insufficient permissions for this action"
}{
"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": "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"
}Members
Add a member to a group
Add a member to a group.
POST
/
v1
/
groups
/
{id}
/
members
Add a member to a group
curl --request POST \
--url https://api.scrip.dev/v1/groups/{id}/members \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"participant_id": "550e8400-e29b-41d4-a716-446655440000",
"on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440010",
"role": "MEMBER"
}
'import requests
url = "https://api.scrip.dev/v1/groups/{id}/members"
payload = {
"participant_id": "550e8400-e29b-41d4-a716-446655440000",
"on_behalf_of_participant_id": "550e8400-e29b-41d4-a716-446655440010",
"role": "MEMBER"
}
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({
participant_id: '550e8400-e29b-41d4-a716-446655440000',
on_behalf_of_participant_id: '550e8400-e29b-41d4-a716-446655440010',
role: 'MEMBER'
})
};
fetch('https://api.scrip.dev/v1/groups/{id}/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.scrip.dev/v1/groups/{id}/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([
'participant_id' => '550e8400-e29b-41d4-a716-446655440000',
'on_behalf_of_participant_id' => '550e8400-e29b-41d4-a716-446655440010',
'role' => 'MEMBER'
]),
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"
payload := strings.NewReader("{\n \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\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.scrip.dev/v1/groups/{id}/members")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/groups/{id}/members")
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 \"participant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"on_behalf_of_participant_id\": \"550e8400-e29b-41d4-a716-446655440010\",\n \"role\": \"MEMBER\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Member(s) added to group"
}{
"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": "forbidden",
"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": "Insufficient permissions for this action"
}{
"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": "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"
}Adds one or more participants to a group. Each entry specifies a participant ID and an optional
role, which defaults to MEMBER if omitted. The other valid role is ADMIN.
If a participant is already an active member of the group, the request will fail for that participant. Previously removed members (status LEFT) can be re-added with a new role assignment.
For usage patterns and examples, see the Groups guide.
Authorizations
ApiKeyAuthBearerAuth
API key passed in the X-API-Key header.
Path Parameters
Group ID
Body
application/json
Member details
- Option 1
- Option 2
Single participant to add (use members array instead for batch operations)
Example:
"550e8400-e29b-41d4-a716-446655440000"
Participant who initiated this change, for audit purposes
Example:
"550e8400-e29b-41d4-a716-446655440010"
Role for the single participant: MEMBER or ADMIN (defaults to MEMBER)
Available options:
MEMBER, ADMIN Example:
"MEMBER"
Response
Member added
Confirmation message
Example:
"Member(s) added to group"
⌘I