close anchor

Type Groups

To post a type to a group:

POST /type/groups

This endpoint provides for including a content type in a group, or linking it to a user group.

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

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

PUT /type/groups

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

In order to edit or update the types in 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 array Include a one-dimensional array in which each key is the UUID of an individual type 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 type in a group:

DELETE /type/groups

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

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

Parameters

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

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