Unily

Get a Unily audience by its alias.

Search Unily audiences by text, aliases, type, and repository, with paging. You must provide at least one of search_text…

Get a Unily dynamic audience (including its filter rules) by alias.

Create or update a Unily dynamic audience by alias. Requires a name and filter rules (each with field, comparisonOperato…

Delete a Unily dynamic audience by alias.

Get a Unily content node by its unique identifier (GUID). Returns the content with its properties. Set include_descendan…

Search Unily content with a Lucene query and pagination. Returns matching content items and a paging token for the next…

Create a new Unily content node. Requires a unique_id (GUID) to assign, a name, the document_type_alias, the parent_uniq…

Create or replace a Unily content node by unique_id (GUID) using a full PUT. Requires parent_unique_id and the full set…

Partially update a Unily content node by unique_id (GUID). Updates only the supplied properties and fields. Use update_c…

Delete a Unily content node by unique_id (GUID). All child content is deleted too. Use query_content to find the unique_…

Create new Unily content by copying a predefined template. Requires the template_id, the parent_id to create under, and…

List the content a Unily user follows, with search and offset pagination (skip/take).

Make a Unily user follow a content item, by user_id and content_id.

Make a Unily user unfollow a content item, by user_id and content_id.

List the users a Unily user follows, with search and offset pagination (skip/take).

Make a Unily user follow another user, by user_id and followed_user_id.

Make a Unily user unfollow another user, by user_id and followed_user_id.

List Unily form submissions. Requires a scope (‘Approvals’, ‘MySubmissions’, or ‘AllSubmissions’). Filter by form_ids, a…

Get a Unily form submission by its submission ID.

Delete a Unily form submission by its submission ID.

Update the approval status of a Unily form submission. State is one of None, PendingApproval, Approved, or Rejected. Opt…

Get a Unily media node by unique identifier (GUID). Set include_descendants to also return child media.

Get a Unily media image by unique identifier (GUID), including file metadata and focal point.

Get a Unily media folder by unique identifier (GUID).

List a Unily user’s tray notifications with offset pagination. Filter by ‘since’ date and page with skip/take.

Post a Unily notification to users or audiences. The message must include the instance’s default system language (common…

Delete a single Unily notification for a user by user_id and notification_id.

List all organisations registered in the Unily instance.

Get a Unily organisation by its unique ID (GUID).

Run a GraphQL search against Unily content. Provide a GraphQL query string and optional variables, operation_name, and l…

List all Unily security groups (static, dynamic, and external).

Get a Unily static security group by its unique ID (GUID), including its members.

Get a Unily dynamic security group by its unique ID (GUID), including its configuration.

List all Unily security roles and their permissions.

Get a Unily security role by its unique ID (GUID).

Get a Unily social comment by its comment ID.

Create a Unily social comment. Requires author_unique_id and type (‘Comment’ or ‘Share’). Set content_unique_id to the c…

Update a Unily social comment by comment_id. Requires author_unique_id and type (‘Comment’ or ‘Share’). Use get_comment…

Delete a Unily social comment by its comment ID.

List Unily social reaction types (e.g. Like). Filter by applicable_document_types (comma-separated aliases) or by conten…

List all Unily document (content) types. Optionally pass iso_code for translated names.

Get a Unily document type by alias. Optionally pass iso_code for translated names.

List Unily data types. Optionally filter by name.

Get a Unily data type by its unique identifier (GUID).

List all Unily user types and their property definitions.

Get a Unily user type by its alias.

List the languages configured in the Unily instance.

List Unily users with pagination. Returns users and a paging token for the next page. Use order_by/direction to sort. Pa…

Get a Unily user by unique identifier (GUID). Use list_users or query_users to find IDs.

Search Unily users with a Lucene query and pagination. Returns matching users and a paging token. Pass paging_token from…

Create a new Unily user. Requires name, login_name, and user_type_alias. Optionally set email, a unique_id (GUID), and p…

Update a Unily user’s properties by unique_id (GUID). Only supplied fields and properties are changed. Use get_user to f…

Delete a Unily user by unique_id (GUID). Use get_user to confirm the user first.

Validate Unily credentials by making a test API call. Returns success status and a message. Use this to confirm the subd…