---
title: "Create an user group"
method: POST
path: "/groups"
tags: ["User"]
---

# Create an user group

`POST /groups`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/groups/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new user group.

## Request body

- object
  - `name` string: The name of user group.
  - `outbound_caller_ids` object[]: A collection of outbound caller IDs.
    - `provider_id` string: The unique ID of the resource.
    - `caller_id` string: Outbound caller id.
    - `description` string: The descriptive information about this outbound caller id.
  - `description` string: The description of user group.

## Response `201`

Created user group

- object
  - `id` string: The unique ID of the resource.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)