close anchor

File Groups

To post a file to a group:

POST /file/groups

In order to post a file to a group, log in a user with editor-level privileges. If the group is linked directly to a user group, be a user in that group (or identified with owner-level privileges), too.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id string The UUID of the file.
group string The UUID of the group.

The data object provided by this endpoint is the file posted to the group.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid for this endpoint function.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update the files in a group:

PUT /file/groups

This endpoint provides for updating the order in which to deliver files in a group.

In order to edit or update the files in a group, log in a user with editor-level privileges. If the group is linked directly to a user group, be a user in that group (or identified with owner-level privileges), too.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id array Include a one-dimensional array in which each key is the UUID of an individual file and its value is an integer declaring its position in the order it will be delivered for the group.
group string The UUID of the group.

The data object provided by this endpoint is the updated group.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid for this endpoint function.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a file in a group:

DELETE /file/groups

This endpoint provides for taking a file out of a group. It will not delete the file itself, but it will no longer be identified with this group.

In order to delete a file in a group, log in a user with editor-level privileges. If the group is linked directly to a user group, be a user in that group (or identified with owner-level privileges), too.

Parameters

Param Type Description
id string The UUID of the file.
group string The UUID of the group.

The data object provided by this endpoint is the file no longer in the group.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid for this endpoint function.

If an error is not described on this page, the platform-wide error table provides further information.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*