syncGroup

Add a Sync Group

Changed on

Add a new Sync Group to the CMS

post/syncgroup/add

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/syncgroup/add
  • Auth
    none declared

Request body application/x-www-form-urlencoded

namestring required

The Sync Group Name

syncPublisherPortinteger

The publisher port number on which sync group members will communicate - default 9590

syncSwitchDelayinteger

The delay (in ms) when displaying the changes in content - default 750

syncVideoPauseDelayinteger

The delay (in ms) before unpausing the video on start - default 100

folderIdinteger

Folder ID to which this object should be assigned to

Response

successful operation

syncGroupIdinteger

The ID of this Entity

namestring

The name of this Entity

createdDtstring

The datetime this entity was created

modifiedDtstring nullable

The datetime this entity was last modified

modifiedByinteger

The ID of the user that last modified this sync group

modifiedByNamestring

The name of the user that last modified this sync group

ownerIdinteger

The ID of the owner of this sync group

ownerstring

The name of the owner of this sync group

syncPublisherPortinteger

The publisher port number

syncSwitchDelayinteger

The delay (in ms) when displaying the changes in content

syncVideoPauseDelayinteger

The delay (in ms) before unpausing the video on start.

leadDisplayIdinteger

The ID of the lead Display for this sync group

leadDisplaystring

The name of the lead Display for this sync group

folderIdinteger

The id of the Folder this Sync Group belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Sync Group

Changes

  • fe497e811c7fRevision changes
    • breaking

      the response property became nullable for the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status