close anchor

Element Groups

To post an element to a group:

POST /element/groups

This endpoint provides for including an element in an element group, or linking it to a user group.

In order to post an element to 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 element.
group string The UUID of the group.

The data object provided by this endpoint is the element 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 delete an element in a group:

DELETE /element/groups

This endpoint provides for deleting an element from a group. It will not delete the element itself, but that element will no longer be identified with this group.

In order to delete an element in a group, log in a user with owner-level privileges.

Parameters

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

The data object provided by this endpoint is the element deleted from 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*