close anchor

Users

To post a user to an entry:

POST /content/users

This endpoint provides for identifying a user with a content entry, thereby inviting that user to be a collaborator. This extends privileges to the user for the entry in question but does not edit their user type, privilege level or inclusion in user groups that will potentially influence the extent to which they will in fact be permitted to update the entry itself.

In order to edit a content entry, log in a user identified with privileges for the entry (being a collaborator).

Parameters

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

Param Type Description
id string The UUID of the content entry.
user string The UUID of the user to be identified with this entry.

The data object provided by this endpoint is the content entry the user is now identified with.

To edit the users identified with an entry:

PUT /content/users

This endpoint provides for updating the order in which users identified with an entry (collaborators) will be delivered for that entry. This enables prioritizing users if desired, for example if the initial user is to be treated as the principal or primary collaborator, etc.

In order to edit the users identified with an entry, log in a user identified with privileges for the entry (being a collaborator).

Parameters

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

Param Type Description
id string The UUID of the content entry.
users object The user(s) to be identified with this entry, being an object in which each key is the UUID of an individual user and its value is an integer declaring its position in the order it will be delivered for this entry.

The data object provided by this endpoint is the updated content entry object.

Errors

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

ID/Type Description
invalid_user The user is not valid for the intended transaction, for example if posting a user that is not yet identified with this entry.

To delete an entry user:

DELETE /content/users

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

In order to edit a content entry, log in a user identified with privileges for the entry (being a collaborator).

Parameters

Param Type Description
id string The UUID of the content entry.
user string The UUID of the user to no longer identify with this entry.

The data object provided by this endpoint is the content entry no longer including the deleted user.

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