INintheloop
Group

Update group.

put/api/v1/group/{groupId}

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Path parameters

groupIdstring required

Group id

Query parameters

doNotAddSystemMessageboolean

Setting that chooses whether to add system message when adding/removing users in group or not

Headers

Authorizationstring

Authorization header

X-Impersonate-Userstring

Impersonation header

Request body

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
weightnumber

Usage weight.

createdstring date-time

Date time of contact creation

modifiedstring date-time

Date time of last time contact was modified

descriptionstring

Group description

sendMailDisabledboolean

Flag indicating whether or not sending notification emails on group is disabled

groupTypestring

Group type -> possible values are defined in GroupType

groupSubTypestring

Group sub type -> possible values are defined in GroupSubType

syncingCompleteboolean

For Shared Group type flag to know is shared synching complete

syncingEnabledboolean

For Shared Group type flag to know is shared synching enabled

nudgeTextstring

Group nudge text string.

subscribedboolean

Flag subscribed indicate that you are subscribe to see posts in this group in inbox

threadingMode'Recipient' | 'Standard'

Threading mode for syncing

archivedboolean required

For Shared Group type flag for archived mode

colourstring

Flag subscribed indicate that you are subscribe to see posts in this group in inbox

channelTypestring

Group channel type.

showTotalCountBadgeboolean

Flag ShowBadgeCount indicate that for this group is total count visible

workspaceIdstring

Workspace id for group

Response

OK

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
weightnumber

Usage weight.

createdstring date-time

Date time of contact creation

modifiedstring date-time

Date time of last time contact was modified

descriptionstring

Group description

sendMailDisabledboolean

Flag indicating whether or not sending notification emails on group is disabled

groupTypestring

Group type -> possible values are defined in GroupType

groupSubTypestring

Group sub type -> possible values are defined in GroupSubType

syncingCompleteboolean

For Shared Group type flag to know is shared synching complete

syncingEnabledboolean

For Shared Group type flag to know is shared synching enabled

nudgeTextstring

Group nudge text string.

subscribedboolean

Flag subscribed indicate that you are subscribe to see posts in this group in inbox

threadingMode'Recipient' | 'Standard'

Threading mode for syncing

archivedboolean required

For Shared Group type flag for archived mode

colourstring

Flag subscribed indicate that you are subscribe to see posts in this group in inbox

channelTypestring

Group channel type.

showTotalCountBadgeboolean

Flag ShowBadgeCount indicate that for this group is total count visible

workspaceIdstring

Workspace id for group

Changes

No recorded changes to this operation across all 1 revision of this API.