Skip to main content
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"
}
'
{
  "message": "Member(s) added to group"
}
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

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Group ID

Body

application/json

Member details

​
participant_id
string<uuid>
required

Single participant to add (use members array instead for batch operations)

Example:

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

​
on_behalf_of_participant_id
string<uuid>

Participant who initiated this change, for audit purposes

Example:

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

​
role
enum<string>

Role for the single participant: MEMBER or ADMIN (defaults to MEMBER)

Available options:
MEMBER,
ADMIN
Example:

"MEMBER"

Response

Member added

​
message
string

Confirmation message

Example:

"Member(s) added to group"