NAiOS IconNAiOS Logo
Volver al catálogo

Hyperise

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.

Acciones
5
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (5)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Client AccountHYPERISE_CREATE_CLIENT_ACCOUNTAcción

Tool to create a new Hyperise client account. Use when an agency plan user needs to provision client sub-accounts.

Parámetros de entrada

  • namestringObligatorio

    Name of the client account to be created.

  • emailstringObligatorioemail

    Email address of the client.

  • extrasobject

    Additional fields to include in the client creation request.

  • business_idstringObligatorio

    ID of the agency or business under which to create the client account.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Image TemplatesHYPERISE_LIST_IMAGE_TEMPLATESAcción

Tool to list active image templates. Use when you need to retrieve all your current templates.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Personalized Short LinkHYPERISE_PERSONALIZED_SHORT_LINKSAcción

Tool to generate a personalized short link. Use when you need a shareable URL with OGP metadata and per-recipient customizations. Provide image_hash and personalization data.

Parámetros de entrada

  • urlstringObligatorio

    Destination URL the short link will redirect to

  • descstringObligatorio

    Page description used in Open Graph preview text

  • titlestringObligatorio

    Page title used in Open Graph preview text

  • image_hashstringObligatorio

    Image Template Hash to use for Open Graph preview

  • query_paramsobjectObligatorio

    Personalisation data as a key→value map. E.g. {'first_name':'John','last_name':'Doe','business_name':'Acme Co.'}

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Hyperise Prospect Business Data (CRUD)HYPERISE_PROSPECT_BUSINESS_DATAAcción

Tool to perform CRUD operations on Hyperise business prospect records. Use when managing business data via the Hyperise API.

Parámetros de entrada

  • idinteger

    Record ID; required for retrieve, update, delete

  • latstring

    Latitude coordinate

  • logostring

    Logo URL or base64 image source

  • longstring

    Longitude coordinate

  • emailstring

    Contact email; must be valid; required for create/update

  • phonestring

    Alternate contact phone number

  • titlestring

    Job title of contact

  • genderstringenum

    Gender of contact

    malefemale
  • websitestring

    Website URL; required for create/update

  • categorystring

    Category of the business

  • job_titlestring

    Job title of contact

  • last_namestring

    Last name of contact

  • operationstringObligatorioenum

    CRUD operation to perform: list, retrieve, create, update, or delete

    listretrievecreateupdatedelete
  • first_namestring

    First name of contact

  • business_namestring

    Name of the business

  • custom_text_1string

    Custom text field 1

  • custom_text_2string

    Custom text field 2

  • custom_text_3string

    Custom text field 3

  • custom_text_4string

    Custom text field 4

  • profile_imagestring

    Profile image URL or base64 source

  • business_phonestring

    Phone number of the business

  • custom_image_1string

    Custom image 1 URL or base64

  • custom_image_2string

    Custom image 2 URL or base64

  • custom_image_3string

    Custom image 3 URL or base64

  • business_addressstring

    Address of the business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

User AuthenticationHYPERISE_USER_AUTHENTICATIONAcción

Tool to authenticate an API token and retrieve user details. Use after obtaining a valid API token from Hyperise settings.

Parámetros de entrada

  • api_tokenstring

    Hyperise API token generated in account settings. Optional: falls back to metadata.query_params.api_token if omitted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not