---
title: "Add a Sync Group"
method: POST
path: "/syncgroup/add"
tags: ["syncGroup"]
---

# Add a Sync Group

`POST /syncgroup/add`

Add a new Sync Group to the CMS

## Response `201`

successful operation

- SyncGroup — Class SyncGroup
  - `syncGroupId` integer — The ID of this Entity
  - `name` string — The name of this Entity
  - `createdDt` string — The datetime this entity was created
  - `modifiedDt` string, nullable — The datetime this entity was last modified
  - `modifiedBy` integer — The ID of the user that last modified this sync group
  - `modifiedByName` string — The name of the user that last modified this sync group
  - `ownerId` integer — The ID of the owner of this sync group
  - `owner` string — The name of the owner of this sync group
  - `syncPublisherPort` integer — The publisher port number
  - `syncSwitchDelay` integer — The delay (in ms) when displaying the changes in content
  - `syncVideoPauseDelay` integer — The delay (in ms) before unpausing the video on start.
  - `leadDisplayId` integer — The ID of the lead Display for this sync group
  - `leadDisplay` string — The name of the lead Display for this sync group
  - `folderId` integer — The id of the Folder this Sync Group belongs to
  - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Sync Group

## Changes

- **2026-07-30** `fe497e811c7f` — 1 breaking, 19 warning, 13 info
  - the response property `modifiedDt` became nullable for the status `201`
  - removed the optional property `bandwidthLimit` from the response with the `201` status
  - removed the optional property `description` from the response with the `201` status
  - removed the optional property `displayGroup` from the response with the `201` status
  - …29 more
- **2026-02-25** `41c04de98ec5` — 1 breaking, 1 info
  - added required request body
  - added the media type `application/json` for the response with the status `201`
- **2023-07-10** `a3c40cebbafa` — 1 info
  - endpoint added
- **2020-02-17** `8e1275395104` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/syncgroup/add/post.md)

---

[API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/9136e3c2cb1d/schema)