close anchor

Groups

To post a group link:

POST /group/groups

This endpoint provides for linking a group (being of a type provided by the /group/types endpoint but not including element, type, or user groups) to a user group, thereby preventing users not in that user group from posting entities to the linked group.

In order to edit a group, log in a user 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 group to be identified with a user group.
group string The UUID of the user group being linked to.

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 group link:

DELETE /group/groups

This endpoint provides for deleting the link between a group and a user group.

In order to edit a group, log in a user with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the group to no longer be identified with a user group.
group string The UUID of the user group.

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

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