Create Group

POST

/groups

Create a new contact group.

Authentication

Required Scope: groups:write

Request Body

Field	Type	Required	Validation	Description
`name`	string	Yes	max:255, unique per tenant	Group name

Response

Success (201 Created): Returns the created group object. Includes message: "Group created successfully".

Response Fields

Field	Type	Description
`id`	integer	Group ID
`name`	string	Group name
`created_at`	string	ISO 8601 datetime
`updated_at`	string	ISO 8601 datetime

Error Responses

Status	Code	Description
422	`VALIDATION_ERROR`	Validation failed
500	`INTERNAL_ERROR`	Failed to create group

Validation Error Messages

Field	Message
`name`	Group name is required / A group with this name already exists

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Successful response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/groups' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "VIP Customers"
}'

Response Example

{}

Modified at 2026-02-25 01:06:20

List Groups

Get Group

Create Group

Authentication#

Request Body#

Response#

Response Fields#

Error Responses#

Validation Error Messages#