Create a group

Creates a group.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request
header Parameters
API-Token
required
string

The API token that is shown in the settings of Notes. It is a 64-digit hex number.

Example: a48865e51c3f4610de8f319bdd7bf691b2aaad827ed31ad1dd6847e617200666
Request Body schema: application/json; charset=utf-8
name
string

The name of the group that you want to create.

description
string

Additional information about the group.

Responses
200
post/api/v1/groups
Request samples
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "success": true,
  • "id": 113,
  • "name": "NYC Office",
  • "description": "Engineers in NYC",
  • "created_at": "2020-02-12T21:50:59.774Z",
  • "updated_at": "2020-02-12T21:50:59.774Z",
  • "users": [
    ]
}