Groups

Create a group

Create a participant group with initial members. At least one ADMIN member is required.

post/v1/groups

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/groups
  • Auth: HTTP bearer

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

namestring required

Display name for the group (1-255 chars)

on_behalf_of_participant_idstring uuid

The participant who asked for this change. Scrip stores it with the membership record; the API does not return it.

Example request

{
  "members": [
    {
      "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "role": "MEMBER"
    }
  ],
  "name": "Sales Team",
  "on_behalf_of_participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b007"
}

Response

Group created with ledger entity

created_atstring date-time

When this group was created

deleted_atstring date-time

When the group was archived (present only if archived)

idstring uuid

Unique identifier for this group

namestring

The name people see for the group.

status'ACTIVE' | 'ARCHIVED'

The group's lifecycle state.

updated_atstring date-time

When this group was last updated

Example response

{
  "created_at": "2027-01-15T10:30:00Z",
  "deleted_at": "2027-01-15T10:30:00Z",
  "id": "0b9e7d3c-5a41-4f68-a2c7-81e4d6b3f907",
  "name": "Sales Team",
  "status": "ACTIVE",
  "updated_at": "2027-01-15T10:30:00Z"
}

Changes

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