v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create File Channel

This API endpoint creates a new file channel. See the File Channel resource for detailed descriptions of the properties.

post/v1/channels/files

Request body

membershipTypestring required

The type of membership that this channel is associated with. Can be one of individual, group or company.

membershipEntityIdstring

Deprecated: Use clientId and companyId instead.

memberIdsstring[]

The ids of the clients to be added to this particular channel. Required for group channels. Ignored for individual and company channels.

clientIdstring

The id of the client this channel is for. Required when membershipType is individual.

companyIdstring

The id of the client this channel belongs to. Required when membershipType is company or when member(s) have multiple companies.

Response

200

idstring

createdAtstring

updatedAtstring

membershipTypestring

clientIdstring

companyIdstring

membershipEntityIdstring

memberIdsstring[]

Example response

{
  "id": "us-west-2_n4dciX6tp/3a45806b-f85e-4b6e-bb47-15293f0d0995",
  "createdAt": "2023-07-14T17:52:16.728194048Z",
  "updatedAt": "2023-07-14T17:52:16.728194048Z",
  "membershipType": "company",
  "clientId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "companyId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "membershipEntityId": "ea13806b-f85e-4b6e-bb47-15293f0d0995",
  "memberIds": [
    "a39833b5-c8b3-47b6-87fb-4c4e224e4b10"
  ]
}