Skip to main content
Hyperise logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 5
  • Triggers: 0
  • Slug: HYPERISE
  • Version: 20261101_00

Tools

Slug: HYPERISE_CREATE_CLIENT_ACCOUNTCreates 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

string
required
Name of the client account (business name) to be created.
string
required
Contact email address for the client account.
object
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.
string
required
Parent business/agency ID to associate with the client account (used for organization purposes in the response).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HYPERISE_LIST_IMAGE_TEMPLATESRetrieves 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HYPERISE_PROSPECT_BUSINESS_DATATool to perform CRUD operations on Hyperise business prospect records. Use when managing business data via the Hyperise API.

Input Parameters

integer
Record ID; required for retrieve, update, delete
string
Latitude coordinate
Logo URL or base64 image source
string
Longitude coordinate
string
Contact email; must be valid; required for create/update
string
Alternate contact phone number
string
Job title of contact
string ("male" | "female")
Gender of contact
string
Website URL; required for create/update
string
Category of the business
string
Job title of contact
string
Last name of contact
string ("list" | "retrieve" | "create" | "update" | "delete")
required
CRUD operation to perform: list, retrieve, create, update, or delete
string
First name of contact
string
Name of the business
string
Custom text field 1
string
Custom text field 2
string
Custom text field 3
string
Custom text field 4
string
Profile image URL or base64 source
string
Phone number of the business
string
Custom image 1 URL or base64
string
Custom image 2 URL or base64
string
Custom image 3 URL or base64
string
Address of the business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HYPERISE_USER_AUTHENTICATIONTool to authenticate an API token and retrieve user details. Use after obtaining a valid API token from Hyperise settings.

Input Parameters

string
Hyperise API token generated in account settings. Optional: if omitted, uses the token from the authenticated connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not