> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Hyperise

> Hyperise is a personalization toolkit that enables sales and marketing teams to add dynamic, personalized elements to images, videos, and websites, enhancing engagement across various channels.

![Hyperise logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hyperise.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=db101da1e73be179f9a45cf7d3084a89)

* **Category:** marketing automation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 5
* **Triggers:** 0
* **Slug:** `HYPERISE`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Client Account
>
> **Slug:** `HYPERISE_CREATE_CLIENT_ACCOUNT`
>
> Creates a Hyperise business prospect record for personalized image campaigns, requiring a website or domain in extras. The response includes the supplied business ID and a normalized record ID.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the client account (business name) to be created.
>
> **email** `string` *required*
>
> Contact email address for the client account.
>
> **extras** `object`
>
> Additional fields for client creation. REQUIRED: 'website' (e.g., '[https://example.com](https://example.com)'). Optional fields include: first\_name, last\_name, business\_phone, business\_address, category, job\_title, logo (URL), profile\_image (URL), custom\_text\_1 through custom\_text\_4, custom\_image\_1 through custom\_image\_3, lat, long.
>
> **business\_id** `string` *required*
>
> Parent business/agency ID to associate with the client account (used for organization purposes in the response).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Image Templates
>
> **Slug:** `HYPERISE_LIST_IMAGE_TEMPLATES`
>
> Retrieves all active personalized image templates for the authenticated user. Use this tool when you need to: - Get a list of available Hyperise image templates - Find template IDs for use with other Hyperise actions - Check template dimensions, preview URLs, or metadata Returns an empty list if no templates exist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Personalized Short Link
>
> **Slug:** `HYPERISE_PERSONALIZED_SHORT_LINKS`
>
> Generate a personalized short link with Open Graph metadata for rich link previews. This tool creates a shareable URL that: - Redirects to your destination page - Shows personalized image previews when shared on social media - Passes personalization data to your landing page Prerequisites: 1. At least one image template must exist in your Hyperise account 2. A custom link domain must be configured in Settings > Custom Domain Use HYPERISE\_LIST\_IMAGE\_TEMPLATES first to get the image\_hash parameter.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The destination URL that the short link will redirect to. Must be a valid, fully-qualified URL (e.g., [https://example.com/landing](https://example.com/landing)).
>
> **desc** `string` *required*
>
> The page description for Open Graph metadata. This appears as the link preview description when shared on social media or messaging apps.
>
> **title** `string` *required*
>
> The page title for Open Graph metadata. This appears as the link preview title when shared on social media or messaging apps.
>
> **image\_hash** `string` *required*
>
> The unique hash identifier for your Hyperise image template. Obtain this from the HYPERISE\_LIST\_IMAGE\_TEMPLATES action or from your Hyperise dashboard under Image Templates.
>
> **query\_params** `object`
>
> Personalization data as key-value pairs. Common keys include: first\_name, last\_name, email, company\_name, job\_title, website, profile\_image\_url. Example: \{'first\_name': 'John', 'company\_name': 'Acme'}
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Hyperise Prospect Business Data (CRUD)
>
> **Slug:** `HYPERISE_PROSPECT_BUSINESS_DATA`
>
> Tool to perform CRUD operations on Hyperise business prospect records. Use when managing business data via the Hyperise API.
>
> #### Input Parameters
>
> **id** `integer`
>
> Record ID; required for retrieve, update, delete
>
> **lat** `string`
>
> Latitude coordinate
>
> **logo** `string`
>
> Logo URL or base64 image source
>
> **long** `string`
>
> Longitude coordinate
>
> **email** `string`
>
> Contact email; must be valid; required for create/update
>
> **phone** `string`
>
> Alternate contact phone number
>
> **title** `string`
>
> Job title of contact
>
> **gender** `string ("male" | "female")`
>
> Gender of contact
>
> **website** `string`
>
> Website URL; required for create/update
>
> **category** `string`
>
> Category of the business
>
> **job\_title** `string`
>
> Job title of contact
>
> **last\_name** `string`
>
> Last name of contact
>
> **operation** `string ("list" | "retrieve" | "create" | "update" | "delete")` *required*
>
> CRUD operation to perform: list, retrieve, create, update, or delete
>
> **first\_name** `string`
>
> First name of contact
>
> **business\_name** `string`
>
> Name of the business
>
> **custom\_text\_1** `string`
>
> Custom text field 1
>
> **custom\_text\_2** `string`
>
> Custom text field 2
>
> **custom\_text\_3** `string`
>
> Custom text field 3
>
> **custom\_text\_4** `string`
>
> Custom text field 4
>
> **profile\_image** `string`
>
> Profile image URL or base64 source
>
> **business\_phone** `string`
>
> Phone number of the business
>
> **custom\_image\_1** `string`
>
> Custom image 1 URL or base64
>
> **custom\_image\_2** `string`
>
> Custom image 2 URL or base64
>
> **custom\_image\_3** `string`
>
> Custom image 3 URL or base64
>
> **business\_address** `string`
>
> Address of the business
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] User Authentication
>
> **Slug:** `HYPERISE_USER_AUTHENTICATION`
>
> Tool to authenticate an API token and retrieve user details. Use after obtaining a valid API token from Hyperise settings.
>
> #### Input Parameters
>
> **api\_token** `string`
>
> Hyperise API token generated in account settings. Optional: if omitted, uses the token from the authenticated connection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
