This resource represents a channel where Files can be shared across Clients and Companies. Items associated with a channel are only accessible to the members of that channel. The members of the channel are set based on the groupType
of the channel.
Properties
This resources uses all common resource properties except created
and items
. Instead this resource uses createdAt
which provides more clarity.
createdAt string
The date this item was created in RFC3339 format.
updatedAt string
The date this item was updated in RFC3339 format.
groupType string
The type of channel. Can be one of individual
, group
or company
.
individual
: This channel type contains a single client
group
: This channel type contains more than one client that belongs to the same company
company
: This channel type is associated with a company and all clients in the company are members. When client is assigned to a company, they will automatically be added to this channel. When a client is delete or removed from a company, they will be removed from this channel.
memberIds array of strings
The user IDs associated with this particular channel. These will always be UUIDs of the members of the channel, including clients and internal users.
{
"id": "us-east-1_JDwzcwQiA/339b6252-d773-4c58-a5ef-236ac3edc566",
"object": "fileChannel",
"createdAt": "2022-08-07T15:04:23Z",
"updatedAt": "2022-08-07T15:12:05Z",
"groupType": "company",
"memberIds": [
"b22a34db-f6ba-40cb-a415-c112d4c853d8",
"1dbb3e36-af70-4f41-89e6-6ddf9e2c62b5",
"5c65898e-ce60-4668-b7c8-901a124d046b"
]
}