close anchor

User Groups

To post a user to a group:

POST /user/groups

This endpoint provides for editing the group(s) identified with a user, but does not expect a user to be logged in. This enables developers to identify and enforce their own expectations in terms of this functionality being exposed to users of different privilege levels, based on the unique demands of their individual project(s).

Parameters

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

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

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

DELETE /user/groups

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

Parameters

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

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