---
title: "Add Group"
method: POST
path: "/business/v2/groups"
tags: ["Groups"]
---

# Add Group

`POST /business/v2/groups`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/groups`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `group_write`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/groups/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to add a new `Group`.

## Request body

- CreateGroup: Create `Group` JSON parameters.
  - `name` string: The name of the `Group`.
  - `custom_reference_id` string: The `Group` reference in an external system.
  - `note` string: Any notes about the `Group`.
  - `type` 'TEAM' | 'PROJECT' | 'DEPARTMENT' | 'DIVISION' | 'SQUAD' | 'UNIT' | 'PRODUCTION'

## Response `200`

The returned resource is a single `Group`.

- Group
  - `id` string: The `Group` ID (sortable: yes).
  - `name` string: The name of the `Group` (sortable: yes).
  - `custom_reference_id` string: The `Group` reference in an external system.
  - `type` 'TEAM' | 'PROJECT' | 'DEPARTMENT' | 'DIVISION' | 'SQUAD' | 'UNIT' | 'PRODUCTION'
  - `note` string: Any notes about the `Group` (sortable: no).
  - `members` string[]: A list of `User` IDs belonging to the `Group` (sortable: no).
  - `wallets` string[]: A list of `Wallet` IDs related to the `Group` (sortable: no).
  - `cards` string[]: A list of `Card` IDs related to the `Group` (sortable: no).
  - `creation_time` string: The date and time when the `Group` was created (sortable: yes).
  - `last_update` string: The date and time when the `Group` was last updated (sortable: yes).

## Other responses

- `400`: Your request has missing arguments or is malformed.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)