# 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.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `HYPERISE`
- **Version:** 20260312_00

## Tools

### Create Client Account

**Slug:** `HYPERISE_CREATE_CLIENT_ACCOUNT`

Creates a new Hyperise business/client account for personalized image campaigns. Use this to provision prospect records that can be linked to Hyperise image templates. The website field is required in the extras parameter. Returns the created account's ID, which can be used with other Hyperise actions like personalized short links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the client account (business name) to be created. |
| `email` | string | Yes | Contact email address for the client account. |
| `extras` | object | No | Additional fields for client creation. REQUIRED: 'website' (e.g., '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 | Yes | Parent business/agency ID to associate with the client account (used for organization purposes in the response). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The destination URL that the short link will redirect to. Must be a valid, fully-qualified URL (e.g., https://example.com/landing). |
| `desc` | string | Yes | The page description for Open Graph metadata. This appears as the link preview description when shared on social media or messaging apps. |
| `title` | string | Yes | 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 | Yes | 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 | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Record ID; required for retrieve, update, delete |
| `lat` | string | No | Latitude coordinate |
| `logo` | string | No | Logo URL or base64 image source |
| `long` | string | No | Longitude coordinate |
| `email` | string | No | Contact email; must be valid; required for create/update |
| `phone` | string | No | Alternate contact phone number |
| `title` | string | No | Job title of contact |
| `gender` | string ("male" | "female") | No | Gender of contact |
| `website` | string | No | Website URL; required for create/update |
| `category` | string | No | Category of the business |
| `job_title` | string | No | Job title of contact |
| `last_name` | string | No | Last name of contact |
| `operation` | string ("list" | "retrieve" | "create" | "update" | "delete") | Yes | CRUD operation to perform: list, retrieve, create, update, or delete |
| `first_name` | string | No | First name of contact |
| `business_name` | string | No | Name of the business |
| `custom_text_1` | string | No | Custom text field 1 |
| `custom_text_2` | string | No | Custom text field 2 |
| `custom_text_3` | string | No | Custom text field 3 |
| `custom_text_4` | string | No | Custom text field 4 |
| `profile_image` | string | No | Profile image URL or base64 source |
| `business_phone` | string | No | Phone number of the business |
| `custom_image_1` | string | No | Custom image 1 URL or base64 |
| `custom_image_2` | string | No | Custom image 2 URL or base64 |
| `custom_image_3` | string | No | Custom image 3 URL or base64 |
| `business_address` | string | No | Address of the business |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_token` | string | No | Hyperise API token generated in account settings. Optional: if omitted, uses the token from the authenticated connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |