--- title: "Update group." method: PUT path: "/api/v1/group/{groupId}" tags: ["Group"] --- # Update group. `PUT /api/v1/group/{groupId}` ## Request - Base URL: `https://api.intheloop.io` - URL: `https://api.intheloop.io/api/v1/group/{groupId}` - Auth: API key in header `Authorization` ## Path parameters - `groupId` string, required ## Query parameters - `doNotAddSystemMessage` boolean ## Headers - `Authorization` string - `X-Impersonate-User` string ## Request body - Group: Group contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `admins` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `members` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `description` string: Group description - `availableSharedTags` ListOfResourcesOfSharedTagBase: List of resources - `resources` SharedTagBase[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `color` string: Tag color - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `sendMailDisabled` boolean: Flag indicating whether or not sending notification emails on group is disabled - `allowedImpersonatedSenders` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `groupType` string: Group type -> possible values are defined in GroupType - `groupSubType` string: Group sub type -> possible values are defined in GroupSubType - `syncingAccount` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `syncingAliasAccount` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `syncingComplete` boolean: For Shared Group type flag to know is shared synching complete - `syncingEnabled` boolean: For Shared Group type flag to know is shared synching enabled - `nudgeText` string: Group nudge text string. - `subscribed` boolean: Flag subscribed indicate that you are subscribe to see posts in this group in inbox - `threadingMode` 'Recipient' | 'Standard': Threading mode for syncing - `archived` boolean, required: For Shared Group type flag for archived mode - `colour` string: Flag subscribed indicate that you are subscribe to see posts in this group in inbox - `channelType` string: Group channel type. - `showTotalCountBadge` boolean: Flag ShowBadgeCount indicate that for this group is total count visible - `workspaceId` string: Workspace id for group ## Response `200` OK - Group: Group contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `admins` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `members` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `description` string: Group description - `availableSharedTags` ListOfResourcesOfSharedTagBase: List of resources - `resources` SharedTagBase[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `color` string: Tag color - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `sendMailDisabled` boolean: Flag indicating whether or not sending notification emails on group is disabled - `allowedImpersonatedSenders` ListOfResourcesOfUser: List of resources - `resources` User[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `groupType` string: Group type -> possible values are defined in GroupType - `groupSubType` string: Group sub type -> possible values are defined in GroupSubType - `syncingAccount` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `syncingAliasAccount` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `syncingComplete` boolean: For Shared Group type flag to know is shared synching complete - `syncingEnabled` boolean: For Shared Group type flag to know is shared synching enabled - `nudgeText` string: Group nudge text string. - `subscribed` boolean: Flag subscribed indicate that you are subscribe to see posts in this group in inbox - `threadingMode` 'Recipient' | 'Standard': Threading mode for syncing - `archived` boolean, required: For Shared Group type flag for archived mode - `colour` string: Flag subscribed indicate that you are subscribe to see posts in this group in inbox - `channelType` string: Group channel type. - `showTotalCountBadge` boolean: Flag ShowBadgeCount indicate that for this group is total count visible - `workspaceId` string: Workspace id for group ## Other responses - `204`: No Content - `400`: Bad request. Check fields message and error code from response body for additional information. - `401`: Unauthorized request. Check fields message and error code from response body for additional information. - `403`: Requested resource forbidden.Check fields message and error code from response body for additional information. - `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request. - `451`: Unavailable because account is not verified. --- [API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)