Skip to content

Create group

POST
/v2/document/group

Create a new group

X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
name
required

The group name

string
description

The group description

string
status
required

The status of the group

string
Allowed values: INPROGRESS TODO COMPLETE ARCHIVED
INPROGRESS
priority
required

The priority of the group

string
Allowed values: LOW MEDIUM HIGH EMPTY
LOW
tags

The Tags

Array<object>
object
id
required

Unique ID for the tag

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
name
required

A unique name for your tag

string
Review
description

A description for your tag

string
Groups with this tag need to be reviewed
color
required

A color for your tag

string
Allowed values: Blue Pink Purple Orange
Blue
status

A tag status

string
Active

The resource has been successfully created.

object
id

A group Id

string
name

A group name

string
description

A group description

string
organisationId

An organisation Id

string
status

The status of the group

string
Allowed values: INPROGRESS TODO COMPLETE ARCHIVED
INPROGRESS
priority

The priority of the group

string
Allowed values: LOW MEDIUM HIGH EMPTY
LOW
tags

A tag array

Array<object>
object
id
required

Unique ID for the tag

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
name
required

A unique name for your tag

string
Review
description

A description for your tag

string
Groups with this tag need to be reviewed
color
required

A color for your tag

string
Allowed values: Blue Pink Purple Orange
Blue
status

A tag status

string
Active