---
title: "Create a group"
method: POST
path: "/v1/groups"
tags: ["Groups"]
---

# Create a group

`POST /v1/groups`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/groups`
- Auth: HTTP bearer

```bash
curl -X POST https://api.subscriby.net/v1/groups \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
        "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",
        "code": "billing-team",
        "name": "Billing Team",
        "permissions": ["project-subscription:view-any"]
      }'
```

> **Choose the code deliberately.** `code` is unique within the team and **cannot be changed afterwards**: permissions are addressed by it. Only `name` and the permission set are mutable.

A group starts empty. Add people with the members endpoint; membership is deliberately not a field here, because replacing who is in a group and naming it are different operations with different consequences.

Answers `201` with the group and its permissions. Emits `group.created`.

## Headers

- `Idempotency-Key` string, uuid, required

## Request body

- StoreGroupRequest: A group's team, code, name and permissions. On create `team_id`, `code` and `name` are required; on update `team_id` and `code` are prohibited (a group is neither moved nor renamed by code) and `name` and `permissions` are optional. Membership is not set here but with the members endpoint.
  - `team_id` string, uuid, required: The team to create the group in; the caller must belong to it, and a team outside their account answers 404. Prohibited on update: a group cannot be moved between teams.
  - `code` string, required: The machine name, up to 255 letters, numbers, dashes and underscores, unique within the team and immutable afterwards because permissions are addressed by it. Prohibited on update.
  - `name` string, required: The display name, up to 255 characters.
  - `permissions` string[]: The permission codes the group grants. Sending it sets the group's permissions to exactly this list; omit the key to leave the existing set untouched. Defaults to none on create.

## Response `201`

The group resource as a 201.

- object
  - `data` object, required: A group: a named permission bundle a team shares between several collaborators, each of whom may be in several groups.
    - `id` string, required: The group's id.
    - `team_id` string, nullable, required: The team the group belongs to.
    - `code` string, required: The machine name, unique within the team and immutable after creation, because permissions are addressed by it.
    - `name` string, required: The display name.
    - `permissions` string[], required: The permission codes the group grants. Returned when the group is read individually or after a write, omitted from list responses so a listing stays one query.
    - `member_ids` string[]: The users in the group. Returned after a member sync, omitted elsewhere.
    - `created_at` string, nullable, required: When the group was created, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description. On this endpoint: `TEAM_TIER_REQUIRED`: below the Growth tier; nothing changes.
- `404`: `RESOURCE_NOT_FOUND`: when `team_id` is not one of the caller's teams.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`. On this endpoint: `VALIDATION_FAILED`: when a group with that code already exists in the team; `error.context.code` names it.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)