Groups

Add a member to a group

Add one or more participants to a group in members, each with an optional role.

post/v1/groups/{group_id}/members

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/groups/{group_id}/members
  • Auth: HTTP bearer

Path parameters

group_idstring uuid required

The group's id.

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Request body

OR

Example request

{
  "on_behalf_of_participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b007",
  "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
  "role": "MEMBER"
}

Response

Member added

messagestring

Confirmation message

Example response

{
  "message": "Member(s) added to group"
}

Changes

No recorded changes to this operation across all 1 revision of this API.