close anchor

User Content Groups

To get information on user content groups:

GET /user/content/groups

In order to get information on user content groups, log a user in. If not identified with owner-level privileges, only groups belonging to that user will be delivered by this endpoint.

Parameters

Param Type Description Optional
id string The UUID of an individual user content group.
user string The UUID of an individual user by which to filter user content groups. If the user presently logged in is not identified with owner-level privileges, this value will be ignored and only user content groups belonging to that user will be delivered. If the user presently logged in is identified with owner-level privileges, include this parameter with an empty value to bypass filtering by user.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, name.

If plural locales indicated for the endpoint transaction and name is present in the list of field(s) to order by, querying will be performed in the initial locale (but data will be included for each).
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of user content group object(s).

To post a user content group:

POST /user/content/groups

In order to post a user content group, log a user in.

Parameters

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

Param Type Description Optional
user string The UUID of the user to be identified with this user content group, to whom it will belong. If not provided, the endpoint will infer this is the user presently logged in. In order to post to a different user, log in a user identified with owner-level privileges.
name string The name of the user content group, provided in the endpoint transaction locale.

The data object provided by this endpoint is the user content group inserted to the project.

Errors

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

ID/Type Description
invalid_group_name The user content group name is an empty value or not provided.

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

To edit a user content group:

PUT /user/content/groups

In order to edit a user content group, log in the user to whom it belongs or a user identified with owner-level privileges.

Parameters

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

Param Type Description
id string The UUID of the user content group to be edited.
name string The name of the user content group, provided in the endpoint transaction locale.

The data object provided by this endpoint is the user content 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_name The user content group name is an empty value or not provided.

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

To delete a user content group:

DELETE /user/content/groups

In order to delete a user content group, log in the user to whom it belongs or a user identified with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the user content group to be deleted.

The data object provided by this endpoint is the deleted user content group.

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