Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Groups and Sections

Update Group and set businesses

Update a group. This endpoint allows you to modify the details of an existing group within the system. Only Group Managers and higher roles can use this endpoint. Business Managers are restricted from accessing it. For more information about the group system, see the Groups and Sections description. ⚠️ You must specify which businesses are part of the group using the business__in parameter.

  • If you don't specify any businesses, the group will be updated to include all businesses. - To update a group to be empty, provide an empty array in the business__in parameter.
post/sections/{section_id}/groups/{group_id}

Path parameters

section_idinteger required

Section ID

group_idinteger required

Group ID

Request body

namestring required

Name of the group. Cannot include any of the following characters: ,;/

business__inBusinessId[] required

List of business ids

Example request

{
  "name": "France",
  "business__in": [
    "5409c35a97bbc544d8e26737",
    "595badaef348ab6b3530033f",
    "59d53302b12ff6429f262639"
  ]
}

Response

OK

status'success'

Request status

idinteger

ID of the created group

Example response

{
  "id": 1
}