Skip to main content
POST
Create instance group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

V3 API: Create an instance-level custom group.

name
string
required

Name of the group

Maximum string length: 254
company_id
integer
required

ID of the company this group belongs to

description
string

Description of the group

Response

Instance group created successfully

Instance group list / retrieve / update — includes the owning company.

id
integer
required
name
string
required
category
string
required
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
user_role
string
required
read-only
members_count
integer
required
read-only
company
object
required

The company a group belongs to (id + name).