Skip to main content
HubSpot logo
  • Category: crm
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 336
  • Triggers: 2
  • Slug: HUBSPOT
  • Version: 20261103_00

Frequently Asked Questions

HubSpot shows this warning because the default Composio-managed HubSpot OAuth app is still awaiting HubSpot approval. The connection can still work, but HubSpot asks the user to explicitly accept the warning before continuing.Composio is working on getting the default HubSpot OAuth app approved, but there is no concrete ETA because the final review timeline depends on HubSpot.If this warning blocks your rollout, use your own HubSpot OAuth app credentials in a custom Composio auth config. That lets you control the app identity, review status, and consent screen shown to your users.
Use Composio-managed auth when you want the fastest setup and the default Composio HubSpot app covers the permissions you need.With Composio-managed HubSpot auth, you can only remove optional scopes that are already available on the Composio-managed HubSpot app.You cannot add new scopes to the managed app, and you cannot remove scopes that are non-optional for that managed auth config. If you need a different scope set, create a custom HubSpot OAuth app and configure those scopes there.Use your own HubSpot OAuth app when you need a different scope set, your own app name and branding on the consent screen, tighter control over app review and rollout, or a production setup owned by your team. For setup steps, see How to create OAuth credentials for HubSpot.
The scope category must match between Composio and your HubSpot developer app.
  • Scopes in Composio scopes must be configured in HubSpot as Required or Conditionally required.
  • Scopes in Composio optional_scopes must be configured in HubSpot as Optional.
  • Do not request a scope from Composio unless that same scope is enabled in the HubSpot developer app.
If you use the API, pass the fields in the auth config credentials:
Use the Create Auth Config API to create the auth config, the Get Auth Config API to inspect what Composio will request, and the Update Auth Config API to change the scope fields.When reading an auth config through the API, check both credentials.scopes and credentials.optional_scopes. Together, they represent the HubSpot permissions Composio can request for that auth config.HubSpot’s docs may refer to the authorization URL parameter as optional_scope; in Composio, the editable auth config field is named optional_scopes.
  • Scope mismatch or callback errors: confirm every requested scope is enabled in HubSpot and is in the same category in both HubSpot and Composio.
  • Missing-scope tool errors: add the missing scope to the auth config and HubSpot developer app, then reconnect the account.
  • Contact list/search limit errors: HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA and HUBSPOT_LIST_CONTACTS_PAGE support a maximum limit of 100 results per request.
  • Webhook setup errors: HubSpot webhooks require a public app with an App ID and Developer API Key. Private or internal apps cannot receive webhooks.
  • Refresh or expiry errors: Common causes include the user revoking the app in HubSpot, HubSpot app credentials changing, the refresh token being invalidated, or the connected account being reauthorized with a different app configuration. After rotating custom OAuth credentials or changing the HubSpot developer app, reconnect affected HubSpot accounts.
If the HubSpot flow loops while Composio works on its side, retry while logged into the correct HubSpot workspace and confirm the OAuth app is public/configured correctly.
HubSpot webhook APIs need the specific HubSpot app that should receive webhook notifications. For user HubSpot triggers, app_id and developer API key are required because each user needs their own HubSpot app for webhook delivery.

Tools

Slug: HUBSPOT_ADD_ASSET_ASSOCIATIONAssociates an existing asset (‘FORM’, ‘OBJECT_LIST’, or ‘EXTERNAL_WEB_URL’) with a specified HubSpot marketing campaign.

Input Parameters

string
required
The unique identifier of the asset to be associated with the campaign. This ID is specific to the assetType. For FORMs, use the form’s numeric ID. For OBJECT_LIST, use the list ID (ILS ID). For EMAIL, use the email’s content ID. For LANDING_PAGE or BLOG_POST, use the page/post ID. These IDs can be obtained from HubSpot’s UI (in the asset’s URL or details panel) or by using the corresponding list/search actions for that asset type.
string
required
Type of asset to associate with the campaign. Commonly supported types include: ‘FORM’, ‘OBJECT_LIST’ (Static/Contact List), ‘EXTERNAL_WEB_URL’, ‘EMAIL’, ‘LANDING_PAGE’, ‘BLOG_POST’, ‘CTA’, ‘WORKFLOW’, ‘SOCIAL_POST’, ‘WEBSITE_PAGE’, ‘SEQUENCE’, ‘MEETING_EVENT’, ‘PLAYBOOK’, ‘FEEDBACK_SURVEY’, ‘SALES_DOCUMENT’. HubSpot continues to expand asset type support over time.
string
required
The unique identifier (UUID) of the HubSpot campaign to which the asset will be associated.

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: HUBSPOT_ADD_TOKEN_TO_EVENT_TEMPLATEAdds a new custom data token to an existing event template for a specified HubSpot application, optionally populating a CRM object property if objectPropertyName is provided.

Input Parameters

string
required
The internal name of the token, used for referencing it within templates. Must be unique for this event template. Allowed characters: alphanumeric, periods (.), dashes (-), or underscores (_).
string ("date" | "enumeration" | "number" | "string")
required
The data type of the token. Determines how the token’s value is stored and validated.
integer
required
Numeric identifier of the target application associated with the event template. Provided in the URL path.
string
required
The user-facing label for the token. This label is used for list segmentation and in reporting.
array
A list of options for the token, required and applicable only if the token type is ‘enumeration’. Each option must have a ‘label’ and a ‘value’.
string
required
Unique identifier of the event template. Provided in the URL path.
string
The name of an existing CRM object property (e.g., ‘dealstage’, ‘lifecyclestage’). If provided, this token will populate the specified CRM object property associated with the event. This allows for building or updating CRM objects through the Timeline API.

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: HUBSPOT_ARCHIVE_BATCH_OF_FEEDBACK_SUBMISSIONSAsynchronously archives a batch of HubSpot feedback submissions using their unique IDs, which must correspond to valid and existing submissions; the operation is queued, and submissions are moved from active views without being deleted.

Input Parameters

array
required
A list of objects, where each object contains the ‘id’ of a feedback submission to be archived.

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: HUBSPOT_ARCHIVE_BATCH_OF_LINE_ITEMSArchives a batch of existing line items by their unique IDs in HubSpot CRM; this operation is irreversible via the API.

Input Parameters

array
required
A list of objects, where each object contains the ‘id’ of a line item to be archived.

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: HUBSPOT_ARCHIVE_BATCH_OF_OBJECTSArchives a batch of existing, non-archived CRM objects of a specified objectType by their IDs, effectively hiding them from active use.

Input Parameters

array
required
A list of input objects, where each object contains the ‘id’ of a CRM record to be archived.
string
required
The type of CRM object to archive (e.g., ‘contacts’, ‘companies’, ‘deals’, ‘tickets’).

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: HUBSPOT_ARCHIVE_BATCH_OF_PROPERTIESArchives a batch of properties by their internal names for a specified HubSpot CRM object type; this operation is idempotent and safe to retry.

Input Parameters

array
required
A list of properties to archive, each specified by its internal name.
string
required
The HubSpot CRM object type for which properties are being archived.

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: HUBSPOT_ARCHIVE_BATCH_OF_QUOTESArchives a batch of existing quotes by their IDs, removing them from active views while keeping them accessible in your HubSpot account for viewing, downloading, cloning, or deletion; note that archived quotes cannot be restored to active status.

Input Parameters

array
required
A list of objects, where each object contains the ID of a quote to be archived.

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: HUBSPOT_ARCHIVE_COMPANIESArchives multiple HubSpot companies by their IDs.

Input Parameters

array
required
A list of company objects, each specifying the ID of the company to be archived.

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: HUBSPOT_ARCHIVE_COMPANYArchives an existing company in HubSpot CRM by its companyId, moving it to a recycling bin from which it can be restored, rather than permanently deleting it.

Input Parameters

string
required
The numeric identifier for the company to archive. Must contain only digits (e.g., ‘1234567890’). Do not use email addresses or other non-numeric identifiers.

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: HUBSPOT_ARCHIVE_CONTACTArchives a HubSpot contact by its ID.

Input Parameters

string
required
Numeric HubSpot contact ID (e.g., ‘386009987808’). Note: The archive endpoint does NOT support email addresses or idProperty - use HUBSPOT_GET_CONTACTS or HUBSPOT_SEARCH_CONTACTS to find the numeric ID first.

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: HUBSPOT_ARCHIVE_CONTACTSArchives multiple HubSpot contacts by their IDs.

Input Parameters

array
required
A list of contact objects, each specifying the ID of the contact to be archived.

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: HUBSPOT_ARCHIVE_CRM_OBJECT_BY_IDArchives a specific HubSpot CRM object by its type and ID, moving it to the recycling bin; this action is irreversible via the API but objects can often be restored via the HubSpot UI.

Input Parameters

string
required
The unique identifier for the CRM object to be archived. This ID must correspond to an existing object of the specified objectType. The format is typically a string of numbers or a UUID. Ensure the correct ID is provided as this operation is irreversible via the API.
string
required
The type of CRM object to be archived. This value is case-sensitive, must be a valid HubSpot CRM object type (e.g., contacts, companies, deals, quotes), and should be provided in lowercase plural form (e.g., ‘contacts’, not ‘Contact’).

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: HUBSPOT_ARCHIVE_DEALSArchives multiple HubSpot deals by their IDs.

Input Parameters

array
required
List of deal objects to be archived.

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: HUBSPOT_ARCHIVE_EMAILArchives a HubSpot CRM email engagement by its numeric object ID, moving it to the recycling bin.

Input Parameters

string
required
Numeric object ID of the email engagement record in HubSpot. This is NOT an email address - it must be a numeric ID (e.g., ‘1234567890’). The ID can be retrieved from the HubSpot CRM email activity list or from previous API responses.

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: HUBSPOT_ARCHIVE_EMAILSArchives multiple HubSpot CRM email engagement records by their IDs.

Input Parameters

array
required
List of email objects to be archived.

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: HUBSPOT_ARCHIVE_FEEDBACK_SUBMISSIONArchives an existing, non-archived Feedback Submission in HubSpot CRM by its ID, moving it to the recycling bin (not permanently deleting it).

Input Parameters

string
required
The unique identifier of an existing Feedback Submission in HubSpot CRM to be archived.

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: HUBSPOT_ARCHIVE_LINE_ITEMArchives a specific HubSpot line item by its ID, moving it to a recoverable state.

Input Parameters

string
required
The unique identifier of the existing line item in HubSpot CRM to be archived.

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: HUBSPOT_ARCHIVE_PRODUCTArchives a HubSpot product by its ID.

Input Parameters

string
required
Unique HubSpot identifier for the product to be archived.

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: HUBSPOT_ARCHIVE_PRODUCTSArchives multiple HubSpot products by their IDs.

Input Parameters

array
required
List of product objects to be archived.

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: HUBSPOT_ARCHIVE_PROPERTY_BY_OBJECT_TYPE_AND_NAMEArchives a specified CRM property by its object type and name, moving it to the recycling bin; note that some default HubSpot properties cannot be archived.

Input Parameters

string
required
The case-sensitive type of CRM object (e.g., ‘contacts’, ‘companies’) for which the property is being archived; must match an existing object type.
string
required
The case-sensitive internal name of the property to archive (e.g., ‘custom_field_1’, ‘annual_revenue’).

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: HUBSPOT_ARCHIVE_PROPERTY_GROUPArchives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its CRM visibility and usability.

Input Parameters

string
required
The unique internal name of the property group you want to archive. This name is case-sensitive and must exactly match an existing property group’s name within the specified objectType.
string
required
The specific CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom object types) that the property group belongs to. This value must be in lowercase and match an existing object type definition in your HubSpot account.

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: HUBSPOT_ARCHIVE_QUOTEArchives a HubSpot Quote object by ID, moving it to the recycling bin where it can be restored within 90 days.

Input Parameters

string
required
The unique identifier (ID) of an existing Quote object in HubSpot CRM to be archived.

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: HUBSPOT_ARCHIVE_TICKETArchives a HubSpot ticket by its ID.

Input Parameters

string
required
Unique HubSpot identifier for the ticket to be archived.

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: HUBSPOT_ARCHIVE_TICKETSArchives multiple HubSpot tickets by their IDs.

Input Parameters

array
required
List of ticket objects to be archived.

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: HUBSPOT_AUDIT_PIPELINE_CHANGESRetrieves a reverse chronological audit log of all changes for a specific, existing HubSpot CRM pipeline, which is identified by its pipelineId and a valid objectType that supports pipelines (e.g., ‘deals’, ‘tickets’).

Input Parameters

string
required
The HubSpot CRM object type that has pipelines (e.g., ‘deals’, ‘tickets’); determines the pipeline’s context. Must be a valid, case-sensitive object type.
string
required
The unique identifier of an existing pipeline within the specified objectType for which to retrieve the audit history.

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: HUBSPOT_BATCH_ARCHIVE_ASSOCIATION_LABELSRemove selected labels from up to 100 HubSpot CRM association pairs. Removing a default unlabeled association also removes every label between that record pair.

Input Parameters

array
required
Between 1 and 100 record pairs and their labels to remove.
string
required
Target CRM object type name or object type ID.
string
required
Source CRM object type name or object type ID.

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: HUBSPOT_BATCH_CREATE_CONTACT_COMPANY_ASSOCIATIONSCreates up to 2,000 labeled contact-to-company associations.

Input Parameters

array
required
Between 1 and 2,000 labeled contact-to-company associations to create.

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: HUBSPOT_BATCH_CREATE_DEAL_COMPANY_ASSOCIATIONSCreates labeled associations from deals to companies in one batch.

Input Parameters

array
required
Deal-to-company associations to create.

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: HUBSPOT_BATCH_CREATE_DEFAULT_ASSOCIATIONSCreate default unlabeled associations for batches of HubSpot CRM record pairs.

Input Parameters

array
required
Between 1 and 2,000 source-to-target record pairs to associate.
string
required
Target CRM object type name or object type ID.
string
required
Source CRM object type name or object type ID.

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: HUBSPOT_BATCH_READ_COMPANIES_BY_PROPERTIESBatch-retrieves up to 100 HubSpot company records by their IDs in a single request. Supports custom ID properties (e.g., domain), selective property retrieval, and historical property values.

Input Parameters

array
required
List of company identifiers to retrieve. Each id within an input object corresponds to the value of the property specified in idProperty.
boolean
If true, returns only archived company records; otherwise (default), returns active, non-archived companies.
string
Property name to use as the unique identifier for companies in inputs. Defaults to hs_object_id (the HubSpot record ID) if not specified. Can be set to any unique company property configured in your HubSpot account.
array
Optional list of company property names to retrieve. If omitted, a default set of properties (name, domain, hs_object_id, createdate, hs_lastmodifieddate, etc.) is returned.
array
Optional list of company property names for which to retrieve historical values. If not provided, no historical data is returned.

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: HUBSPOT_BATCH_READ_LIST_MEMBERSHIPSRetrieve list memberships for multiple HubSpot CRM records.

Input Parameters

array
required
CRM records to retrieve list memberships for. At least one record is required.

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: HUBSPOT_BATCH_READ_WORKFLOW_ID_MAPPINGSResolves current flow IDs and legacy workflow IDs in one batch.

Input Parameters

array
required
Coordinates to resolve, each identified by either flowId or workflowId according to its type.

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: HUBSPOT_BATCH_READ_WORKFLOWSRetrieves multiple HubSpot automation workflows by flow ID.

Input Parameters

array
required
One or more unique HubSpot workflow IDs to retrieve.

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: HUBSPOT_BATCH_UPDATE_QUOTESUpdates multiple existing HubSpot quotes in a batch; each quote is identified by its object ID or a custom unique property (via idProperty), and only writable properties are modified.

Input Parameters

array
required
List of InputsRequest objects, each specifying a quote to update and its new property values.

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: HUBSPOT_CANCEL_IMPORTCancels an active HubSpot data import job using its importId; this action is irreversible, and any data already processed will remain.

Input Parameters

integer
required
The unique identifier for the active HubSpot import job to be cancelled; must correspond to an import job currently in progress.

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: HUBSPOT_CLONE_MARKETING_EMAILDuplicates an existing HubSpot marketing email, identified by its id, into a new draft; an optional cloneName can be assigned to this new email copy.

Input Parameters

string
required
The unique identifier of the existing marketing email to be cloned.
string
The name for the newly cloned marketing email. If not provided, HubSpot may assign a default name (e.g., ‘Copy of [Original Email Name]’).

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: HUBSPOT_CONFIGURE_CALLING_EXTENSION_SETTINGSConfigures or updates settings for a HubSpot app’s calling extension, including its name, UI URL, iframe dimensions, isReady status, and supportsCustomObjects flag, for the specified appId.

Input Parameters

string
required
Publicly accessible HTTPS URL for the phone/calling UI, which should be built using the HubSpot Calling SDK.
string
required
Display name for the calling service in the HubSpot interface.
integer
required
Unique identifier for the target HubSpot app whose calling extension settings are being configured.
integer
required
Target width in pixels for the iframe embedding the calling UI.
integer
required
Target height in pixels for the iframe embedding the calling UI.
boolean
If true, the calling service appears as an option under the ‘Call’ action in contact records; false hides it.
boolean
Specifies if the service is compatible with HubSpot’s engagement v2 service and custom objects.

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: HUBSPOT_CREATE_AB_TEST_VARIATIONCreates a new A/B test variation for an existing HubSpot marketing email, using its contentId; the new variation is created as a draft that can be edited before publishing. This action only creates the variation—it does not start the A/B test or send emails. Note: If an active variation already exists for the email, a new one will not be created. Requires Marketing Hub Professional or Enterprise subscription.

Input Parameters

string
required
The ID of the original email content to use as a template for the new variation.
string
required
A unique name for the new A/B test variation.

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: HUBSPOT_CREATE_AND_RETURN_A_NEW_PROPERTY_GROUPCreates a new, empty property group for a specified CRM object type in HubSpot, requiring a unique group name for that object type; properties must be added separately.

Input Parameters

string
required
The unique internal programmatic name for the property group within the specified objectType, used for API referencing.
string
required
Human-readable label for the property group, displayed in the HubSpot UI.
string
required
The CRM object type for which the property group will be created.
integer
Order in which the group appears in the HubSpot UI. Positive values are sorted ascendingly; -1 places it after groups with positive displayOrder. If unspecified, the group is added at the end.

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: HUBSPOT_CREATE_A_NEW_MARKETING_EMAILCreates a new marketing email in HubSpot, allowing comprehensive configuration of content, recipients, sender details, A/B testing, scheduling, web version, and other settings; the internal name for the email is required.

Input Parameters

string
required
Internal name of the email, as displayed on the HubSpot email dashboard.
string ("AUTOMATED" | "AUTOMATED_DRAFT" | "AUTOMATED_SENDING" | "AUTOMATED_FOR_FORM" | "AUTOMATED_FOR_FORM_BUFFER" | "AUTOMATED_FOR_FORM_DRAFT" | "AUTOMATED_FOR_FORM_LEGACY" | "BLOG_EMAIL_DRAFT" | "BLOG_EMAIL_PUBLISHED" | "DRAFT" | "DRAFT_AB" | "DRAFT_AB_VARIANT" | "ERROR" | "LOSER_AB_VARIANT" | "PAGE_STUB" | "PRE_PROCESSING" | "PROCESSING" | "PUBLISHED" | "PUBLISHED_AB" | "PUBLISHED_AB_VARIANT" | "PUBLISHED_OR_SCHEDULED" | "RSS_TO_EMAIL_DRAFT" | "RSS_TO_EMAIL_PUBLISHED" | "SCHEDULED" | "SCHEDULED_AB" | "SCHEDULED_OR_PUBLISHED" | "AUTOMATED_AB" | "AUTOMATED_AB_VARIANT" | "AUTOMATED_DRAFT_AB" | "AUTOMATED_DRAFT_ABVARIANT" | "AUTOMATED_LOSER_ABVARIANT")
Current state of the email (e.g., DRAFT, SCHEDULED, PUBLISHED).
string
The subject line of the marketing email.
boolean
True if the email is archived (typically hidden from main dashboard view).
string
ID (GUID) of the associated HubSpot campaign for tracking/reporting.
string ("af" | "af-na" | "af-za" | "agq" | "agq-cm" | "ak" | "ak-gh" | "am" | "am-et" | "ar" | "ar-001" | "ar-ae" | "ar-bh" | "ar-dj" | "ar-dz" | "ar-eg" | "ar-eh" | "ar-er" | "ar-il" | "ar-iq" | "ar-jo" | "ar-km" | "ar-kw" | "ar-lb" | "ar-ly" | "ar-ma" | "ar-mr" | "ar-om" | "ar-ps" | "ar-qa" | "ar-sa" | "ar-sd" | "ar-so" | "ar-ss" | "ar-sy" | "ar-td" | "ar-tn" | "ar-ye" | "as" | "as-in" | "asa" | "asa-tz" | "ast" | "ast-es" | "az" | "az-az" | "bas" | "bas-cm" | "be" | "be-by" | "bem" | "bem-zm" | "bez" | "bez-tz" | "bg" | "bg-bg" | "bm" | "bm-ml" | "bn" | "bn-bd" | "bn-in" | "bo" | "bo-cn" | "bo-in" | "br" | "br-fr" | "brx" | "brx-in" | "bs" | "bs-ba" | "ca" | "ca-ad" | "ca-es" | "ca-fr" | "ca-it" | "ccp" | "ccp-bd" | "ccp-in" | "ce" | "ce-ru" | "ceb" | "ceb-ph" | "cgg" | "cgg-ug" | "chr" | "chr-us" | "ckb" | "ckb-iq" | "ckb-ir" | "cs" | "cs-cz" | "cu" | "cu-ru" | "cy" | "cy-gb" | "da" | "da-dk" | "da-gl" | "dav" | "dav-ke" | "de" | "de-at" | "de-be" | "de-ch" | "de-de" | "de-gr" | "de-it" | "de-li" | "de-lu" | "dje" | "dje-ne" | "doi" | "doi-in" | "dsb" | "dsb-de" | "dua" | "dua-cm" | "dyo" | "dyo-sn" | "dz" | "dz-bt" | "ebu" | "ebu-ke" | "ee" | "ee-gh" | "ee-tg" | "el" | "el-cy" | "el-gr" | "en" | "en-001" | "en-150" | "en-ae" | "en-ag" | "en-ai" | "en-as" | "en-at" | "en-au" | "en-bb" | "en-be" | "en-bi" | "en-bm" | "en-bs" | "en-bw" | "en-bz" | "en-ca" | "en-cc" | "en-ch" | "en-ck" | "en-cm" | "en-cn" | "en-cx" | "en-cy" | "en-de" | "en-dg" | "en-dk" | "en-dm" | "en-er" | "en-fi" | "en-fj" | "en-fk" | "en-fm" | "en-gb" | "en-gd" | "en-gg" | "en-gh" | "en-gi" | "en-gm" | "en-gu" | "en-gy" | "en-hk" | "en-ie" | "en-il" | "en-im" | "en-in" | "en-io" | "en-je" | "en-jm" | "en-ke" | "en-ki" | "en-kn" | "en-ky" | "en-lc" | "en-lr" | "en-ls" | "en-lu" | "en-mg" | "en-mh" | "en-mo" | "en-mp" | "en-ms" | "en-mt" | "en-mu" | "en-mw" | "en-mx" | "en-my" | "en-na" | "en-nf" | "en-ng" | "en-nl" | "en-nr" | "en-nu" | "en-nz" | "en-pg" | "en-ph" | "en-pk" | "en-pn" | "en-pr" | "en-pw" | "en-rw" | "en-sb" | "en-sc" | "en-sd" | "en-se" | "en-sg" | "en-sh" | "en-si" | "en-sl" | "en-ss" | "en-sx" | "en-sz" | "en-tc" | "en-tk" | "en-to" | "en-tt" | "en-tv" | "en-tz" | "en-ug" | "en-um" | "en-us" | "en-vc" | "en-vg" | "en-vi" | "en-vu" | "en-ws" | "en-za" | "en-zm" | "en-zw" | "eo" | "eo-001" | "es" | "es-419" | "es-ar" | "es-bo" | "es-br" | "es-bz" | "es-cl" | "es-co" | "es-cr" | "es-cu" | "es-do" | "es-ea" | "es-ec" | "es-es" | "es-gq" | "es-gt" | "es-hn" | "es-ic" | "es-mx" | "es-ni" | "es-pa" | "es-pe" | "es-ph" | "es-pr" | "es-py" | "es-sv" | "es-us" | "es-uy" | "es-ve" | "et" | "et-ee" | "eu" | "eu-es" | "ewo" | "ewo-cm" | "fa" | "fa-af" | "fa-ir" | "ff" | "ff-bf" | "ff-cm" | "ff-gh" | "ff-gm" | "ff-gn" | "ff-gw" | "ff-lr" | "ff-mr" | "ff-ne" | "ff-ng" | "ff-sl" | "ff-sn" | "fi" | "fi-fi" | "fil" | "fil-ph" | "fo" | "fo-dk" | "fo-fo" | "fr" | "fr-be" | "fr-bf" | "fr-bi" | "fr-bj" | "fr-bl" | "fr-ca" | "fr-cd" | "fr-cf" | "fr-cg" | "fr-ch" | "fr-ci" | "fr-cm" | "fr-dj" | "fr-dz" | "fr-fr" | "fr-ga" | "fr-gf" | "fr-gn" | "fr-gp" | "fr-gq" | "fr-ht" | "fr-km" | "fr-lu" | "fr-ma" | "fr-mc" | "fr-mf" | "fr-mg" | "fr-ml" | "fr-mq" | "fr-mr" | "fr-mu" | "fr-nc" | "fr-ne" | "fr-pf" | "fr-pm" | "fr-re" | "fr-rw" | "fr-sc" | "fr-sn" | "fr-sy" | "fr-td" | "fr-tg" | "fr-tn" | "fr-vu" | "fr-wf" | "fr-yt" | "fur" | "fur-it" | "fy" | "fy-nl" | "ga" | "ga-gb" | "ga-ie" | "gd" | "gd-gb" | "gl" | "gl-es" | "gsw" | "gsw-ch" | "gsw-fr" | "gsw-li" | "gu" | "gu-in" | "guz" | "guz-ke" | "gv" | "gv-im" | "ha" | "ha-gh" | "ha-ne" | "ha-ng" | "haw" | "haw-us" | "he" | "hi" | "hi-in" | "hr" | "hr-ba" | "hr-hr" | "hsb" | "hsb-de" | "hu" | "hu-hu" | "hy" | "hy-am" | "ia" | "ia-001" | "id" | "ig" | "ig-ng" | "ii" | "ii-cn" | "id-id" | "is" | "is-is" | "it" | "it-ch" | "it-it" | "it-sm" | "it-va" | "he-il" | "ja" | "ja-jp" | "jgo" | "jgo-cm" | "yi" | "yi-001" | "jmc" | "jmc-tz" | "jv" | "jv-id" | "ka" | "ka-ge" | "kab" | "kab-dz" | "kam" | "kam-ke" | "kde" | "kde-tz" | "kea" | "kea-cv" | "khq" | "khq-ml" | "ki" | "ki-ke" | "kk" | "kk-kz" | "kkj" | "kkj-cm" | "kl" | "kl-gl" | "kln" | "kln-ke" | "km" | "km-kh" | "kn" | "kn-in" | "ko" | "ko-kp" | "ko-kr" | "kok" | "kok-in" | "ks" | "ks-in" | "ksb" | "ksb-tz" | "ksf" | "ksf-cm" | "ksh" | "ksh-de" | "kw" | "kw-gb" | "ku" | "ku-tr" | "ky" | "ky-kg" | "lag" | "lag-tz" | "lb" | "lb-lu" | "lg" | "lg-ug" | "lkt" | "lkt-us" | "ln" | "ln-ao" | "ln-cd" | "ln-cf" | "ln-cg" | "lo" | "lo-la" | "lrc" | "lrc-iq" | "lrc-ir" | "lt" | "lt-lt" | "lu" | "lu-cd" | "luo" | "luo-ke" | "luy" | "luy-ke" | "lv" | "lv-lv" | "mai" | "mai-in" | "mas" | "mas-ke" | "mas-tz" | "mer" | "mer-ke" | "mfe" | "mfe-mu" | "mg" | "mg-mg" | "mgh" | "mgh-mz" | "mgo" | "mgo-cm" | "mi" | "mi-nz" | "mk" | "mk-mk" | "ml" | "ml-in" | "mn" | "mn-mn" | "mni" | "mni-in" | "mr" | "mr-in" | "ms" | "ms-bn" | "ms-id" | "ms-my" | "ms-sg" | "mt" | "mt-mt" | "mua" | "mua-cm" | "my" | "my-mm" | "mzn" | "mzn-ir" | "naq" | "naq-na" | "nb" | "nb-no" | "nb-sj" | "nd" | "nd-zw" | "nds" | "nds-de" | "nds-nl" | "ne" | "ne-in" | "ne-np" | "nl" | "nl-aw" | "nl-be" | "nl-ch" | "nl-bq" | "nl-cw" | "nl-lu" | "nl-nl" | "nl-sr" | "nl-sx" | "nmg" | "nmg-cm" | "nn" | "nn-no" | "nnh" | "nnh-cm" | "no" | "no-no" | "nus" | "nus-ss" | "nyn" | "nyn-ug" | "om" | "om-et" | "om-ke" | "or" | "or-in" | "os" | "os-ge" | "os-ru" | "pa" | "pa-in" | "pa-pk" | "pcm" | "pcm-ng" | "pl" | "pl-pl" | "prg" | "prg-001" | "ps" | "ps-af" | "ps-pk" | "pt" | "pt-ao" | "pt-br" | "pt-ch" | "pt-cv" | "pt-gq" | "pt-gw" | "pt-lu" | "pt-mo" | "pt-mz" | "pt-pt" | "pt-st" | "pt-tl" | "qu" | "qu-bo" | "qu-ec" | "qu-pe" | "rm" | "rm-ch" | "rn" | "rn-bi" | "ro" | "ro-md" | "ro-ro" | "rof" | "rof-tz" | "ru" | "ru-by" | "ru-kg" | "ru-kz" | "ru-md" | "ru-ru" | "ru-ua" | "rw" | "rw-rw" | "rwk" | "rwk-tz" | "sa" | "sa-in" | "sah" | "sah-ru" | "saq" | "saq-ke" | "sat" | "sat-in" | "sbp" | "sbp-tz" | "sd" | "sd-in" | "sd-pk" | "se" | "se-fi" | "se-no" | "se-se" | "seh" | "seh-mz" | "ses" | "ses-ml" | "sg" | "sg-cf" | "shi" | "shi-ma" | "si" | "si-lk" | "sk" | "sk-sk" | "sl" | "sl-si" | "smn" | "smn-fi" | "sn" | "sn-zw" | "so" | "so-dj" | "so-et" | "so-ke" | "so-so" | "sq" | "sq-al" | "sq-mk" | "sq-xk" | "sr" | "sr-ba" | "sr-cs" | "sr-me" | "sr-rs" | "sr-xk" | "su" | "su-id" | "sv" | "sv-ax" | "sv-fi" | "sv-se" | "sw" | "sw-cd" | "sw-ke" | "sw-tz" | "sw-ug" | "sy" | "ta" | "ta-in" | "ta-lk" | "ta-my" | "ta-sg" | "te" | "te-in" | "teo" | "teo-ke" | "teo-ug" | "tg" | "tg-tj" | "th" | "th-th" | "ti" | "ti-er" | "ti-et" | "tk" | "tk-tm" | "tl" | "to" | "to-to" | "tr" | "tr-cy" | "tr-tr" | "tt" | "tt-ru" | "twq" | "twq-ne" | "tzm" | "tzm-ma" | "ug" | "ug-cn" | "uk" | "uk-ua" | "ur" | "ur-in" | "ur-pk" | "uz" | "uz-af" | "uz-uz" | "vai" | "vai-lr" | "vi" | "vi-vn" | "vo" | "vo-001" | "vun" | "vun-tz" | "wae" | "wae-ch" | "wo" | "wo-sn" | "xh" | "xh-za" | "xog" | "xog-ug" | "yav" | "yav-cm" | "yo" | "yo-bj" | "yo-ng" | "yue" | "yue-cn" | "yue-hk" | "zgh" | "zgh-ma" | "zh" | "zh-cn" | "zh-hk" | "zh-mo" | "zh-sg" | "zh-tw" | "zh-hans" | "zh-hant" | "zu" | "zu-za")
Primary language of the email content.
string
Scheduled ISO 8601 date-time for email publication or sending.
string
Email subcategory for internal organization or specific types (e.g., ‘newsletter’).
string
Domain for sending the email; must be a connected and verified HubSpot sending domain.
string
URL of the RSS feed for email content. Must be valid and accessible if using RSS features.
string
Primary ‘From’ and reply-to email address, unless from__customReplyTo is used.
boolean
True to send email immediately on publish; false to publish without sending until triggered/scheduled.
string
The ID of the business unit this email is associated with, if applicable.
string
Sender name appearing in the ‘From’ field of the received email.
object
A dictionary specifying the timing and scheduling details for sending RSS emails. Each key must map to a dictionary/object value, not a simple string. Example: {“dayOfWeek”: {“value”: “Tuesday”}, “time”: {“hour”: 9, “minute”: 0}}.
string
The unique identifier for the A/B test associated with this email.
object
Dictionary of widgets (e.g., text, images, CTAs) and their configurations for email content. Each key must map to a dictionary/object value, not a simple string. Example: {“widgetId”: {“type”: “text”, “content”: “Hello”, “style”: {…}}}.
string
The ID of the feedback survey linked to the email.
string
Custom URL slug for the email’s web version (e.g., ‘july-newsletter’).
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Current A/B test status for this email (e.g., master, variant).
string
Browser tab title for the email’s web version.
object
Dictionary defining content and layout of flexible, customizable areas in the email template. Each key must map to a dictionary/object value, not a simple string. Example: {“areaName”: {“content”: {…}, “layout”: {…}}}.
string
Domain for the email’s web version; defaults to HubSpot domain if unspecified.
string
Custom reply-to email address, overrides main ‘Reply To’ if set.
string
Specifies the layout to be used for the blog RSS email.
integer
The maximum number of blog posts (RSS entries) to include in a single RSS email.
object
Dictionary of smart fields for email personalization based on contact properties. Each key must map to a dictionary/object value, not a simple string. Example: {“fieldName”: {“value”: “defaultValue”, “conditions”: {…}}}.
integer
Hours to wait for A/B test results before sending the winning version to remaining recipients.
boolean
True to not send to contacts identified by HubSpot as ‘graymail’ (low engagement).
string
Path to the email template in HubSpot Design Manager.
string
ISO 8601 date-time when the web version expires and becomes inaccessible.
string
The type of blog email, which determines send frequency (e.g., instant, daily, weekly).
string
The ID of the HubSpot blog to be used for the RSS email.
boolean
True to apply HubSpot’s send frequency limits, preventing over-mailing.
array
List of specific contact IDs to explicitly exclude, even if in included lists.
array
List of specific contact IDs to include as recipients.
string ("CLICKS_BY_OPENS" | "CLICKS_BY_DELIVERED" | "OPENS_BY_DELIVERED")
Metric (e.g., CLICKS_BY_OPENS) to determine the A/B test winning version.
string
Plain text version of the email, for non-HTML clients or recipient preference.
object
Dictionary of widget containers for grouping and managing widgets in the email template. Each key must map to a dictionary/object value, not a simple string. Example: {“containerId”: {“widgets”: […], “layout”: {…}}}.
string
The HTML template for formatting each individual RSS entry within the email.
integer
Percentage of recipients in the A/B test group (e.g., 20 for 20%).
array
List of contact list IDs whose members to explicitly exclude. HubSpot contact list IDs are typically numeric strings (e.g., ‘12345’, ‘67890’). Provide the numeric ID as a string.
array
List of contact list IDs whose members to include as recipients. HubSpot contact list IDs are typically numeric strings (e.g., ‘12345’, ‘67890’). Provide the numeric ID as a string.
string
Custom URL for redirect if web version link is expired/deactivated.
integer
The maximum width for images included from the blog feed in the RSS email.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Default email version (master/variant) if A/B test is inconclusive after the test period.
string
Meta description for the web version, used by search engines.
object
Dictionary of theme settings values to customize email appearance. Each key must map to a dictionary/object value, not a simple string. Example: {“brandColor”: {“value”: “#0055CC”}, “fontFamily”: {“name”: “Arial”}}.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Default email version (master/variant) if A/B test sample size is too small for significance.
string
ID of a HubSpot page for redirect if web version link is expired/deactivated.
boolean
If true, the email subject will be automatically populated from the blog post headline for RSS emails.
string
ID of the specific subscription type (e.g., newsletter, product updates).
string
ID of the office location for CAN-SPAM compliance and personalization.
string
ID of the subscription preferences group for managing recipient preferences.

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: HUBSPOT_CREATE_ASSOCIATIONCreates a new custom association definition (schema) for a custom object in HubSpot, specifying how this object type can relate to another object type; this defines the association type itself, not actual record-to-record links. Note: This endpoint requires crm.schemas.custom.write scope and only works with custom objects (not standard HubSpot objects like contacts or companies).

Input Parameters

string
Optional, user-defined unique name for the new association type (e.g., ‘contact_to_company_custom’). If not supplied, HubSpot may generate a default.
string
required
Fully qualified name or object type ID (e.g., ‘2-12345’) of the CUSTOM object schema for which the new association type is being defined. Must be a custom object, not a standard HubSpot object.
string
required
Object type ID or fully qualified name for the ‘to’ side of the association. For standard objects use names (‘contacts’, ‘companies’, ‘deals’, ‘tickets’) or IDs (‘0-1’, ‘0-2’, ‘0-3’, ‘0-5’). For custom objects use their objectTypeId (e.g., ‘2-12345’).
string
required
Object type ID or fully qualified name for the ‘from’ side of the association. For standard objects use names (‘contacts’, ‘companies’, ‘deals’, ‘tickets’) or IDs (‘0-1’, ‘0-2’, ‘0-3’, ‘0-5’). For custom objects use their objectTypeId (e.g., ‘2-12345’).

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: HUBSPOT_CREATE_ASSOCIATION_LABELCreate a custom relationship-label definition between two CRM object types.

Input Parameters

string
required
Unique internal name for the association definition.
string
required
Human-readable label describing the forward relationship.
string
Optional human-readable label for the reverse relationship.
string
required
Destination CRM object type name or object type ID.
string
required
Source CRM object type name or object type ID.

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: HUBSPOT_CREATE_BATCH_OF_FEEDBACK_SUBMISSIONSCreates a batch of feedback submissions in HubSpot, ideal for bulk imports; all property names, associationTypeIds, and association to_ids must reference existing entities in HubSpot.

Input Parameters

array
required
A list of feedback submission objects to create. Each object defines the properties and associations for a new feedback submission.

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: HUBSPOT_CREATE_BATCH_OF_OBJECTSCreates multiple CRM objects of a specified objectType (e.g., contacts, companies, deals) in a single batch operation, where each object can have its own set of properties and associations.

Input Parameters

array
required
A list of objects to be created in batch. Each item in the list defines the properties and associations for a new object.
string
required
The type of CRM object to create in batch (e.g., ‘contacts’, ‘companies’, ‘deals’, ‘tickets’, ‘products’, ‘line_items’, or a custom object ID). Must be a valid HubSpot CRM object type.

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: HUBSPOT_CREATE_BATCH_OF_PROPERTIESEfficiently creates multiple CRM properties in a single batch for a specified HubSpot object type (e.g., ‘contacts’, ‘companies’, custom object ID), ideal for schema setup or updates.

Input Parameters

array
required
List of definitions for the new properties to be created.
string
required
Target HubSpot CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom object ID) for property creation.

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: HUBSPOT_CREATE_BATCH_OF_QUOTESCreates multiple HubSpot CRM quotes in a batch, ideal for bulk operations; provide meaningful quote details in inputs as property requirements can vary, and inspect response for individual quote statuses as partial success is possible.

Input Parameters

array
required
A list of quote objects to be created. Each object in the list defines the properties and associations for a new quote.

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: HUBSPOT_CREATE_BLOG_POSTCreate a HubSpot CMS blog post, defaulting to a draft.

Input Parameters

string
required
Internal blog-post name.
string
URL slug for the post.
string
Requested HubSpot publication state.
array
Numeric HubSpot blog tag IDs represented as strings to preserve 64-bit precision.
string ("aa" | "ab" | "ae" | "af" | "af-na" | "af-za" | "agq" | "agq-cm" | "ak" | "ak-gh" | "am" | "am-et" | "an" | "ann" | "ann-ng" | "ar" | "ar-001" | "ar-ae" | "ar-bh" | "ar-dj" | "ar-dz" | "ar-eg" | "ar-eh" | "ar-er" | "ar-il" | "ar-iq" | "ar-jo" | "ar-km" | "ar-kw" | "ar-lb" | "ar-ly" | "ar-ma" | "ar-mr" | "ar-om" | "ar-ps" | "ar-qa" | "ar-sa" | "ar-sd" | "ar-so" | "ar-ss" | "ar-sy" | "ar-td" | "ar-tn" | "ar-ye" | "as" | "as-in" | "asa" | "asa-tz" | "ast" | "ast-es" | "av" | "ay" | "az" | "az-az" | "ba" | "bal" | "bal-pk" | "bas" | "bas-cm" | "be" | "be-by" | "bem" | "bem-zm" | "bez" | "bez-tz" | "bg" | "bg-bg" | "bgc" | "bgc-in" | "bho" | "bho-in" | "bi" | "blo" | "blo-bj" | "bm" | "bm-ml" | "bn" | "bn-bd" | "bn-in" | "bo" | "bo-cn" | "bo-in" | "br" | "br-fr" | "brx" | "brx-in" | "bs" | "bs-ba" | "ca" | "ca-ad" | "ca-es" | "ca-fr" | "ca-it" | "ccp" | "ccp-bd" | "ccp-in" | "ce" | "ce-ru" | "ceb" | "ceb-ph" | "cgg" | "cgg-ug" | "ch" | "chr" | "chr-us" | "ckb" | "ckb-iq" | "ckb-ir" | "co" | "cr" | "cs" | "cs-cz" | "csw" | "csw-ca" | "cu" | "cu-ru" | "cv" | "cv-ru" | "cy" | "cy-gb" | "da" | "da-dk" | "da-gl" | "dav" | "dav-ke" | "de" | "de-at" | "de-be" | "de-ch" | "de-de" | "de-gr" | "de-it" | "de-li" | "de-lu" | "dje" | "dje-ne" | "doi" | "doi-in" | "dsb" | "dsb-de" | "dua" | "dua-cm" | "dv" | "dyo" | "dyo-sn" | "dz" | "dz-bt" | "ebu" | "ebu-ke" | "ee" | "ee-gh" | "ee-tg" | "el" | "el-cy" | "el-gr" | "en" | "en-001" | "en-150" | "en-ae" | "en-ag" | "en-ai" | "en-as" | "en-at" | "en-au" | "en-bb" | "en-be" | "en-bi" | "en-bm" | "en-bs" | "en-bw" | "en-bz" | "en-ca" | "en-cc" | "en-ch" | "en-ck" | "en-cm" | "en-cn" | "en-cx" | "en-cy" | "en-cz" | "en-de" | "en-dg" | "en-dk" | "en-dm" | "en-ee" | "en-eg" | "en-er" | "en-es" | "en-fi" | "en-fj" | "en-fk" | "en-fm" | "en-fr" | "en-gb" | "en-gd" | "en-gg" | "en-gh" | "en-gi" | "en-gm" | "en-gs" | "en-gu" | "en-gy" | "en-hk" | "en-hu" | "en-id" | "en-ie" | "en-il" | "en-im" | "en-in" | "en-io" | "en-it" | "en-je" | "en-jm" | "en-ke" | "en-ki" | "en-kn" | "en-ky" | "en-lc" | "en-lr" | "en-ls" | "en-lu" | "en-mg" | "en-mh" | "en-mo" | "en-mp" | "en-ms" | "en-mt" | "en-mu" | "en-mv" | "en-mw" | "en-mx" | "en-my" | "en-na" | "en-nf" | "en-ng" | "en-nl" | "en-no" | "en-nr" | "en-nu" | "en-nz" | "en-pg" | "en-ph" | "en-pk" | "en-pl" | "en-pn" | "en-pr" | "en-pt" | "en-pw" | "en-ro" | "en-rw" | "en-sb" | "en-sc" | "en-sd" | "en-se" | "en-sg" | "en-sh" | "en-si" | "en-sk" | "en-sl" | "en-ss" | "en-sx" | "en-sz" | "en-tc" | "en-th" | "en-tk" | "en-tn" | "en-to" | "en-tt" | "en-tv" | "en-tz" | "en-ug" | "en-um" | "en-us" | "en-vc" | "en-vg" | "en-vi" | "en-vn" | "en-vu" | "en-ws" | "en-za" | "en-zm" | "en-zw" | "eo" | "eo-001" | "es" | "es-419" | "es-ar" | "es-bo" | "es-br" | "es-bz" | "es-cl" | "es-co" | "es-cr" | "es-cu" | "es-do" | "es-ea" | "es-ec" | "es-es" | "es-gq" | "es-gt" | "es-hn" | "es-ic" | "es-mx" | "es-ni" | "es-pa" | "es-pe" | "es-ph" | "es-pr" | "es-py" | "es-sv" | "es-us" | "es-uy" | "es-ve" | "et" | "et-ee" | "eu" | "eu-es" | "ewo" | "ewo-cm" | "fa" | "fa-af" | "fa-ir" | "ff" | "ff-bf" | "ff-cm" | "ff-gh" | "ff-gm" | "ff-gn" | "ff-gw" | "ff-lr" | "ff-mr" | "ff-ne" | "ff-ng" | "ff-sl" | "ff-sn" | "fi" | "fi-fi" | "fil" | "fil-ph" | "fj" | "fo" | "fo-dk" | "fo-fo" | "fr" | "fr-be" | "fr-bf" | "fr-bi" | "fr-bj" | "fr-bl" | "fr-ca" | "fr-cd" | "fr-cf" | "fr-cg" | "fr-ch" | "fr-ci" | "fr-cm" | "fr-dj" | "fr-dz" | "fr-fr" | "fr-ga" | "fr-gf" | "fr-gn" | "fr-gp" | "fr-gq" | "fr-ht" | "fr-km" | "fr-lu" | "fr-ma" | "fr-mc" | "fr-mf" | "fr-mg" | "fr-ml" | "fr-mq" | "fr-mr" | "fr-mu" | "fr-nc" | "fr-ne" | "fr-pf" | "fr-pm" | "fr-re" | "fr-rw" | "fr-sc" | "fr-sn" | "fr-sy" | "fr-td" | "fr-tg" | "fr-tn" | "fr-vu" | "fr-wf" | "fr-yt" | "frr" | "frr-de" | "fur" | "fur-it" | "fy" | "fy-nl" | "ga" | "ga-gb" | "ga-ie" | "gaa" | "gaa-gh" | "gd" | "gd-gb" | "gl" | "gl-es" | "gn" | "gsw" | "gsw-ch" | "gsw-fr" | "gsw-li" | "gu" | "gu-in" | "guz" | "guz-ke" | "gv" | "gv-im" | "ha" | "ha-gh" | "ha-ne" | "ha-ng" | "haw" | "haw-us" | "he" | "he-il" | "hi" | "hi-in" | "hmn" | "ho" | "hr" | "hr-ba" | "hr-hr" | "hsb" | "hsb-de" | "ht" | "ht-ht" | "hu" | "hu-hu" | "hy" | "hy-am" | "hz" | "ia" | "ia-001" | "id" | "id-id" | "ie" | "ie-ee" | "ig" | "ig-ng" | "ii" | "ii-cn" | "ik" | "io" | "is" | "is-is" | "it" | "it-ch" | "it-it" | "it-sm" | "it-va" | "iu" | "ja" | "ja-jp" | "jgo" | "jgo-cm" | "jmc" | "jmc-tz" | "jv" | "jv-id" | "ka" | "ka-ge" | "kab" | "kab-dz" | "kam" | "kam-ke" | "kar" | "kde" | "kde-tz" | "kea" | "kea-cv" | "kg" | "kgp" | "kgp-br" | "kh" | "khq" | "khq-ml" | "ki" | "ki-ke" | "kj" | "kk" | "kk-kz" | "kkj" | "kkj-cm" | "kl" | "kl-gl" | "kln" | "kln-ke" | "km" | "km-kh" | "kn" | "kn-in" | "ko" | "ko-cn" | "ko-kp" | "ko-kr" | "kok" | "kok-in" | "kr" | "ks" | "ks-in" | "ksb" | "ksb-tz" | "ksf" | "ksf-cm" | "ksh" | "ksh-de" | "ku" | "ku-tr" | "kv" | "kw" | "kw-gb" | "kxv" | "kxv-in" | "ky" | "ky-kg" | "la" | "lag" | "lag-tz" | "lb" | "lb-lu" | "lg" | "lg-ug" | "li" | "lij" | "lij-it" | "lkt" | "lkt-us" | "lmo" | "lmo-it" | "ln" | "ln-ao" | "ln-cd" | "ln-cf" | "ln-cg" | "lo" | "lo-la" | "lrc" | "lrc-iq" | "lrc-ir" | "lt" | "lt-lt" | "lu" | "lu-cd" | "luo" | "luo-ke" | "luy" | "luy-ke" | "lv" | "lv-lv" | "mai" | "mai-in" | "mas" | "mas-ke" | "mas-tz" | "mdf" | "mdf-ru" | "mer" | "mer-ke" | "mfe" | "mfe-mu" | "mg" | "mg-mg" | "mgh" | "mgh-mz" | "mgo" | "mgo-cm" | "mh" | "mi" | "mi-nz" | "mk" | "mk-mk" | "ml" | "ml-in" | "mn" | "mn-mn" | "mni" | "mni-in" | "mr" | "mr-in" | "ms" | "ms-bn" | "ms-id" | "ms-my" | "ms-sg" | "mt" | "mt-mt" | "mua" | "mua-cm" | "my" | "my-mm" | "mzn" | "mzn-ir" | "na" | "naq" | "naq-na" | "nb" | "nb-no" | "nb-sj" | "nd" | "nd-zw" | "nds" | "nds-de" | "nds-nl" | "ne" | "ne-in" | "ne-np" | "ng" | "nl" | "nl-aw" | "nl-be" | "nl-bq" | "nl-ch" | "nl-cw" | "nl-lu" | "nl-nl" | "nl-sr" | "nl-sx" | "nmg" | "nmg-cm" | "nn" | "nn-no" | "nnh" | "nnh-cm" | "no" | "no-no" | "nqo" | "nqo-gn" | "nr" | "nso" | "nso-za" | "nus" | "nus-ss" | "nv" | "ny" | "nyn" | "nyn-ug" | "oc" | "oc-es" | "oc-fr" | "oj" | "om" | "om-et" | "om-ke" | "or" | "or-in" | "os" | "os-ge" | "os-ru" | "pa" | "pa-in" | "pa-pk" | "pcm" | "pcm-ng" | "pi" | "pis" | "pis-sb" | "pl" | "pl-pl" | "prg" | "prg-001" | "ps" | "ps-af" | "ps-pk" | "pt" | "pt-ao" | "pt-br" | "pt-ch" | "pt-cv" | "pt-gq" | "pt-gw" | "pt-lu" | "pt-mo" | "pt-mz" | "pt-pt" | "pt-st" | "pt-tl" | "qu" | "qu-bo" | "qu-ec" | "qu-pe" | "raj" | "raj-in" | "rm" | "rm-ch" | "rn" | "rn-bi" | "ro" | "ro-md" | "ro-ro" | "rof" | "rof-tz" | "ru" | "ru-by" | "ru-kg" | "ru-kz" | "ru-md" | "ru-ru" | "ru-ua" | "rw" | "rw-rw" | "rwk" | "rwk-tz" | "sa" | "sa-in" | "sah" | "sah-ru" | "saq" | "saq-ke" | "sat" | "sat-in" | "sbp" | "sbp-tz" | "sc" | "sc-it" | "sd" | "sd-in" | "sd-pk" | "se" | "se-fi" | "se-no" | "se-se" | "seh" | "seh-mz" | "ses" | "ses-ml" | "sg" | "sg-cf" | "shi" | "shi-ma" | "si" | "si-lk" | "sk" | "sk-sk" | "sl" | "sl-si" | "sm" | "smn" | "smn-fi" | "sms" | "sms-fi" | "sn" | "sn-zw" | "so" | "so-dj" | "so-et" | "so-ke" | "so-so" | "sq" | "sq-al" | "sq-mk" | "sq-xk" | "sr" | "sr-ba" | "sr-cs" | "sr-me" | "sr-rs" | "sr-xk" | "ss" | "st" | "st-ls" | "st-za" | "su" | "su-id" | "sv" | "sv-ax" | "sv-fi" | "sv-se" | "sw" | "sw-cd" | "sw-ke" | "sw-tz" | "sw-ug" | "sy" | "syr" | "syr-iq" | "syr-sy" | "szl" | "szl-pl" | "ta" | "ta-in" | "ta-lk" | "ta-my" | "ta-sg" | "te" | "te-in" | "teo" | "teo-ke" | "teo-ug" | "tg" | "tg-tj" | "th" | "th-th" | "ti" | "ti-er" | "ti-et" | "tk" | "tk-tm" | "tl" | "tn" | "tn-bw" | "tn-za" | "to" | "to-to" | "tok" | "tok-001" | "tr" | "tr-cy" | "tr-tr" | "ts" | "tt" | "tt-ru" | "tw" | "twq" | "twq-ne" | "ty" | "tzm" | "tzm-ma" | "ug" | "ug-cn" | "uk" | "uk-ua" | "ur" | "ur-in" | "ur-pk" | "uz" | "uz-af" | "uz-uz" | "vai" | "vai-lr" | "ve" | "vec" | "vec-it" | "vi" | "vi-vn" | "vmw" | "vmw-mz" | "vo" | "vo-001" | "vun" | "vun-tz" | "wa" | "wae" | "wae-ch" | "wo" | "wo-sn" | "xh" | "xh-za" | "xnr" | "xnr-in" | "xog" | "xog-ug" | "yav" | "yav-cm" | "yi" | "yi-001" | "yi-ua" | "yo" | "yo-bj" | "yo-ng" | "yrl" | "yrl-br" | "yrl-co" | "yrl-ve" | "yue" | "yue-cn" | "yue-hk" | "yue-mo" | "za" | "za-cn" | "zgh" | "zgh-ma" | "zh" | "zh-cn" | "zh-hans" | "zh-hant" | "zh-hk" | "zh-mo" | "zh-my" | "zh-sg" | "zh-tw" | "zu" | "zu-za")
ISO 639 language code for the post; omit to inherit the parent blog’s language.
string
HTML or text body of the post.
string
Browser and search-result title.
string
Summary content.
string
ISO 8601 publication date and time.
string
ID of the HubSpot blog author.
Featured-image URL.
string
required
ID of the parent HubSpot blog.
string
SEO meta description.
Whether the post uses its featured image.
boolean
Whether to publish immediately.
Alternative text for the featured image.

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: HUBSPOT_CREATE_CAMPAIGNCreates a new HubSpot campaign.

Input Parameters

object
required
Campaign properties including name and optional metadata.

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: HUBSPOT_CREATE_CAMPAIGNSCreates multiple HubSpot campaigns by calling the single campaign creation endpoint for each campaign. Note: HubSpot does not provide a native batch create endpoint for campaigns. This action creates multiple campaigns by making individual API calls for each campaign in the batch.

Input Parameters

array
required
List of campaign objects to create.

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: HUBSPOT_CREATE_CAMPAIGN_SPEND_ITEMRecords a spend item against a HubSpot marketing campaign.

Input Parameters

string
required
Spend-item name.
integer
required
Sequence order, where 0 is oldest.
number
required
Monetary value of the spend item.
string
required
UUID of the HubSpot campaign.
string
Optional notes about the spend item.

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: HUBSPOT_CREATE_COMPANIESCreates multiple new HubSpot companies in a single batch operation.

Input Parameters

array
required
A list of company objects to create. Each object represents one new company with its properties.

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: HUBSPOT_CREATE_COMPANYCreates a new HubSpot company.

Input Parameters

string
Company’s postal code.
string
City where the company is located.
string
Company name.
string
Type of company.
string
Company’s primary phone number.
string
State or region where the company is located.
string
Company’s primary domain name.
string
Company street address.
string
Country where the company is located.
string
Company’s website URL.
string
Company description or about us information.
string
Additional address information (suite, floor, etc.).
string
The type of business the company performs. Must be one of HubSpot’s predefined industry enum values in SCREAMING_SNAKE_CASE (e.g., COMPUTER_SOFTWARE, FINANCIAL_SERVICES, HOSPITAL_HEALTH_CARE, RETAIL, BIOTECHNOLOGY). See HubSpot’s company properties documentation for the full list of ~120 valid values.
string
Company’s timezone.
string
Whether the company is publicly traded.
string
Brief description of the company.
array
List of associations to create with other existing HubSpot objects.
string
Year the company was founded.
string
Company’s annual revenue.
string
Current lifecycle stage of the company.
object
Custom properties for the company.
string
Number of employees in the company.

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: HUBSPOT_CREATE_CONTACTCreates a new HubSpot contact.

Input Parameters

string
The contact’s fax number.
string
The contact’s postal code or ZIP code.
string
The city where the contact resides.
string
The primary email address of the contact. This is a unique identifier for contacts in HubSpot.
string
The contact’s primary phone number (often a business phone).
string
URL of the contact’s photo or avatar.
string
The state or region where the contact resides.
string
The contact’s highest completed educational degree.
string
The contact’s gender.
string
The name of the school, college, or university the contact attended.
string
The contact’s street address, including apartment or unit number.
string
The name of the company the contact works for. If associatedcompanyid is set, this field might be auto-populated.
string
The country where the contact resides.
string
The city associated with the contact’s IP address, often captured during their first website visit or form submission.
string
A free-text message or note often captured from a form submission’s message field.
string
The URL of the contact’s personal or company website.
string
The primary industry of the company the contact works for.
string
The state or region associated with the contact’s IP address.
string
The contact’s job title.
string
The contact’s last name.
string
The date when the deal associated with this contact was closed. Expected format is a UTC timestamp in milliseconds.
string
The contact’s first name.
string
The approximate latitude and longitude associated with the contact’s IP address, typically in ‘latitude,longitude’ format.
string
The total number of notes logged on the contact’s record.
string
The full name of the HubSpot user who owns this contact. Read-only.
string
The contact’s seniority level within their organization.
string
The date and time when the contact record was created in HubSpot. This is a read-only property, typically a UTC timestamp.
string
The country associated with the contact’s IP address.
string
The postal code or ZIP code associated with the contact’s IP address.
string
The email address of the HubSpot user who owns this contact. Read-only, reflects the owner’s primary email.
string
The salutation for the contact (e.g., ‘Mr.’, ‘Ms.’, ‘Dr.’).
string
The contact’s start date, typically referring to their employment start date at their current company. Format can vary.
string
The contact’s biography from their Twitter profile.
string
The contact’s work email address. This might be different from the primary email if that’s a personal address.
string
The contact’s biography from their LinkedIn profile.
string
The contact’s mobile phone number.
array
List of associations to create with other existing HubSpot objects (e.g., companies, deals).
string
The size of the company the contact works for, often categorized (e.g., ‘1-10 employees’, ‘501-1000 employees’).
string
The contact’s HubSpot lead score, calculated based on criteria defined in your HubSpot portal’s scoring settings.
string
The contact’s job function or department.
string
The number of employees at the company the contact works for. This may differ from ‘company_size’ if manually entered or from a different source.
string
The annual revenue of the company the contact works for.
string
The contact’s date of birth. Format can vary, but YYYY-MM-DD is common.
string
The number of days it took to close the deal associated with this contact. This is usually calculated automatically.
string
The number of followers the contact has on a specified social media platform (e.g., Twitter).
string
The state or region code associated with the contact’s IP address (e.g., US state code).
string
The total revenue generated from all closed-won deals associated with this contact.
string
The contact’s Twitter username (handle), without the ’@’ symbol.
string
The contact’s primary field of study during their education.
Legal basis for processing contact data under GDPR and privacy regulations.
string
The contact’s current stage in your sales and marketing funnel (e.g., ‘Lead’, ‘Marketing Qualified Lead’, ‘Customer’). These stages are customizable in HubSpot.
string
The contact’s marital status.
string
The contact’s graduation date from their educational institution. Format can vary.
string
A semicolon-separated list of all HubSpot Team IDs this contact is or has been associated with.
string
The ID of the HubSpot team that owns this contact.
string
The two-letter country code (ISO 3166-1 alpha-2) associated with the contact’s IP address.
string
The contact’s military status.
string
A semicolon-separated list of all HubSpot Owner IDs who have been assigned to this contact at some point.
string
The ID of the HubSpot user who is the current owner of this contact.
string
The date and time when the contact record was last modified. This is a read-only property, UTC timestamp.
object
A dictionary of custom properties to set for the contact. Keys are the internal names of your custom contact properties, and values are the data to set. Example: {'custom_property_internal_name': 'value_for_custom_property'}. Note: For common properties with enum values like hs_legal_basis, use the dedicated field instead of custom_properties to ensure proper validation.
string
The contact’s general Klout score, if available and integrated. Klout was a service that rated social media influence.
string
The date and time when the notes on the contact record were last updated. UTC timestamp in milliseconds.
string
The amount of the most recent closed-won deal associated with this contact.
string
The ID of the primary company associated with this contact. This is a read-only property automatically updated when an association is made.
string
Indicates whether the contact is currently active in any HubSpot workflow. Boolean value, ‘true’ or ‘false’.
string
A semicolon-separated list of all HubSpot Contact VID (Visitor ID) values associated with this contact, typically used for merging contacts.
string
The original source that generated the contact (e.g., ‘Organic Search’, ‘Paid Social’, ‘Referrals’).
string
The number of LinkedIn connections the contact has.
string
The number of notes on the contact record that relate to being contacted (e.g., call logs, meeting notes).
string
The contact’s self-reported relationship status.
string
URL of the contact’s Twitter profile photo.
string
A semicolon-separated list of additional email addresses for the contact.
string
Revenue attributed to this contact through HubSpot’s analytics or e-commerce integrations. This is often a sum of closed-won deal amounts associated with the contact.
string
The date and time the contact was last contacted, based on logged activities like calls, emails, or meetings. UTC timestamp in milliseconds.
string
The total number of deals currently associated with this contact.
string
The date and time of the contact’s first conversion (e.g., form submission). UTC timestamp.
string
The last URL on your website that the contact visited.
string
The total number of conversion events (e.g., form submissions, CTA clicks) attributed to this contact.
string
The first URL on your website that the contact visited.
string
The date and time of the contact’s most recent conversion event. UTC timestamp.
string
The close date of the most recent closed-won deal associated with this contact. UTC timestamp in milliseconds.
string
The date and time when the first deal was created for this contact. UTC timestamp.
string
The total number of sessions (visits) the contact has had on your website.
string
Timestamp of the last update related to a webinar event (e.g., GoToWebinar) for this contact, if integrated. UTC timestamp.
string
The date and time of the next scheduled activity (e.g., task, meeting) with the contact. UTC timestamp in milliseconds.
string
A semicolon-separated list of HubSpot Team IDs that have access to this contact record.
string
The last referring URL that brought the contact to your website before their most recent session.
string
Additional detail for the source. For ‘Organic search’, this might be the search engine. For ‘Paid social’, this could be the social media platform.
string
Further detail for the source. For ‘Organic search’, this might be the keyword. For ‘Paid social’, this could be the campaign name.
string
The date and time when a HubSpot owner was most recently assigned to this contact. UTC timestamp in milliseconds.
string
The name or identifier of the event that marked the contact’s first conversion.
string
The first referring URL that brought the contact to your website.
string
Timestamp of the contact’s last recorded interaction (e.g., last website visit, form submission). UTC timestamp.
string
The total number of pages viewed by the contact on your website.
string
The timestamp of the last update to the primary associated company. This is a read-only property.
string
Timestamp of the contact’s first recorded interaction (e.g., first website visit). UTC timestamp.
string
The number of unique types of conversion events completed by the contact.
string
The name or identifier of the contact’s most recent conversion event.
string
Timestamp of the last update related to a SurveyMonkey event for this contact, if integrated. UTC timestamp.
string
Timestamp of the last meeting booked with the contact through HubSpot’s meetings tool.
string
The average number of pages viewed by the contact per session on your website, tracked by HubSpot analytics.
string
A semicolon-separated list of Business Unit IDs assigned to this contact, if using HubSpot’s Business Units feature.
string
Timestamp of the contact’s most recent visit to your website. UTC timestamp.
string
Timestamp of the contact’s first visit to your website. UTC timestamp.
string
The total number of HubSpot custom events completed by the contact.
string
The medium (e.g., ‘Meetings Tool’, ‘Email’) through which the last meeting was booked.
string
The source (e.g., ‘SALES’, ‘MARKETING’) of the last meeting booked.
string
The HubSpot campaign ID (GUID) associated with the last meeting booked.
string
The HubSpot campaign ID (GUID) of the campaign that led to the contact’s most recent conversion.
string
The HubSpot campaign ID (GUID) of the campaign that led to the contact’s first conversion.

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: HUBSPOT_CREATE_CONTACT_FROM_NLCreates a HubSpot contact from a natural language description, using the contact property schema and an LLM-generated property payload. Requires an OpenAI API key and can include supplied associations.

Input Parameters

string
required
Natural language description of the contact to create. Example: ‘Add Jane Smith, email jane@test.com, phone +1-555-0100, company Acme Corp’.
array
Optional associations to create between the new contact and other CRM objects (e.g., companies, deals). Pass-through field, not LLM-generated.

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: HUBSPOT_CREATE_CONTACTSCreates multiple HubSpot contacts in a batch, with contact properties and optional associations to existing CRM records. Custom properties should use the internal names of properties already defined in the account.

Input Parameters

array
required
A list of contact objects to create. Each object represents one new contact with its properties and optional associations.

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: HUBSPOT_CREATE_CONTENT_TEMPLATECreate a HubSpot Design Manager template from HubL or HTML source.

Input Parameters

string
required
Design Manager path for the new template, including its filename.
string
Optional Design Manager folder for the template; an empty string selects the root folder.
string
required
Complete HubL or HTML source for the template.
string
required
HubSpot template category ID.
integer
required
HubSpot template type ID.
boolean
Whether users can select this template when creating new content.

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: HUBSPOT_CREATE_CRM_OBJECT_FROM_NLCreates a HubSpot CRM record from a natural-language description, including contacts, deals, companies, tickets, and custom objects. Optional associations can link the new record to other CRM objects.

Input Parameters

string
required
Natural language description of the record to create. Example: ‘Create a contact named John Doe with email john@example.com and phone +1-555-0100’.
string
required
The type of CRM object to create. Standard types: ‘contacts’, ‘deals’, ‘companies’, ‘tickets’. Can also be a custom object type ID.
array
Optional associations to create between the new object and other CRM objects. Pass-through field, not LLM-generated. Each association should include ‘to’ and ‘types’.

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: HUBSPOT_CREATE_CRM_OBJECT_WITH_PROPERTIESCreates a new HubSpot CRM object (e.g., contact, company, custom object) with specified properties (using valid internal names) and associations (to existing objects via valid type IDs).

Input Parameters

string
required
Type of CRM object to create (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom object schema ID like ‘p12345678’).
object
required
Key-value pairs for the object’s properties. Keys must be internal HubSpot property names valid for the objectType. IMPORTANT: Some properties are enumeration types that only accept specific values. For CONTACTS: ‘email’ (string), ‘firstname’ (string), ‘lastname’ (string), ‘phone’ (string), ‘lifecyclestage’ (enum: subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer, evangelist, other). For COMPANIES: ‘name’ (string, required), ‘domain’ (string), ‘phone’ (string), ‘city’ (string), ‘state’ (string), ‘country’ (string), ‘industry’ (enum - must use UPPERCASE values like: ACCOUNTING, AIRLINES_AVIATION, BANKING, BIOTECHNOLOGY, COMPUTER_SOFTWARE, CONSTRUCTION, CONSUMER_GOODS, EDUCATION_MANAGEMENT, ENTERTAINMENT, FINANCIAL_SERVICES, FOOD_BEVERAGES, GOVERNMENT_ADMINISTRATION, HEALTH_WELLNESS_AND_FITNESS, HOSPITAL_HEALTH_CARE, HOSPITALITY, INFORMATION_TECHNOLOGY_AND_SERVICES, INSURANCE, INTERNET, LEGAL_SERVICES, MANAGEMENT_CONSULTING, MANUFACTURING, MARKETING_AND_ADVERTISING, MEDIA_PRODUCTION, NON_PROFIT_ORGANIZATION_MANAGEMENT, OIL_ENERGY, PHARMACEUTICALS, REAL_ESTATE, RETAIL, TELECOMMUNICATIONS, TRANSPORTATION_TRUCKING_RAILROAD, VENTURE_CAPITAL_PRIVATE_EQUITY, WHOLESALE, and ~115 more). For DEALS: ‘dealname’ (string, required), ‘amount’ (string/number), ‘dealstage’ (enum: pipeline-specific stage IDs), ‘closedate’ (ISO 8601 date), ‘pipeline’ (pipeline ID). For TICKETS: ‘subject’ (string), ‘content’ (string), ‘hs_pipeline’ (pipeline ID), ‘hs_pipeline_stage’ (stage ID), ‘hs_ticket_priority’ (enum: LOW, MEDIUM, HIGH). Use GET /crm/v3/properties/{objectType} to retrieve all valid properties and their enum options for any object type.
array
required
List of associations to create between the new object and existing CRM objects, using to_id and types.

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: HUBSPOT_CREATE_DEALCreates a new HubSpot deal.

Input Parameters

string
Total monetary value of the deal.
string
Annual Contract Value (ACV) (HubSpot-calculated).
string
Annual Recurring Revenue (ARR) (HubSpot-calculated).
string
Monthly Recurring Revenue (MRR) (HubSpot-calculated).
string
Total Contract Value (TCV) (HubSpot-calculated).
string
Descriptive name or title of the deal.
string
Type of deal (e.g., ‘newbusiness’, ‘existingbusiness’).
string
ID of the sales pipeline for this deal (required).
string
Date (YYYY-MM-DD) or datetime (ISO 8601) when the deal closed or is expected to close.
string
Valid pipeline stage ID for the deal. IMPORTANT: Stage IDs must be actual values from your HubSpot pipeline configuration - random values, phone numbers, or placeholder text will be rejected by the API with INVALID_OPTION errors. Stage IDs can be either string-based (e.g., ‘closedwon’, ‘closedlost’) or numeric strings (e.g., ‘2317386479’) depending on your pipeline setup. You MUST retrieve valid stage IDs using the Pipelines API (GET /crm/v3/pipelines/deals) or from HubSpot Settings > Objects > Deals > Pipelines before setting this field.
string
Date/time deal was created (read-only, HubSpot-set).
string
Detailed text description of the deal.
string
GUID of the HubSpot campaign that generated this deal.
string
Priority level (e.g., ‘high’, ‘medium’, ‘low’).
array
Associations to create between the new deal and other CRM objects (e.g., contact, company).
string
Indicates if deal is closed (‘true’/‘false’; read-only, from deal stage properties).
string
Next planned step for this deal.
string
Unique ID of the deal object (read-only, HubSpot-assigned).
string
Days between creation and close (read-only, HubSpot-calculated).
string
Specific date/time deal record created (ISO 8601, read-only, HubSpot-set).
string
Semicolon-separated list of all associated team IDs (owner’s primary, additional teams; typically read-only).
string
Semicolon-separated list of all owner IDs (primary, co-owners).
string
Actual amount when deal closed (HubSpot-calculated).
string
ID of the HubSpot user owning the deal; may be auto-assigned if unspecified.
string
Reason why the deal was won.
object
Custom properties for the deal. Keys are internal property names (as defined in your HubSpot account), values are the property values to set. CRITICAL: Enum/dropdown properties have STRICT validation - you MUST use exact values from your HubSpot configuration or the API will reject with INVALID_OPTION error. To find valid values: go to HubSpot Settings > Properties > Deals > [Property Name] > Edit > Field Type Options. Requirements by type: (1) Enum/dropdown: case-sensitive exact match required (check your HubSpot property settings for valid options); (2) Number: numeric strings only, no units (e.g., ‘12’ not ‘12 months’); (3) Date: ISO 8601 format (e.g., ‘2024-01-15’); (4) Checkbox: ‘true’ or ‘false’. Properties are account-specific and may not exist in all HubSpot portals. Example: {'project_type': 'migration', 'priority_level': 'high'}.
string
Reason why the deal was lost.
string
Currency code for deal amount. IMPORTANT: Only currency codes enabled in your HubSpot portal settings are valid. If omitted, defaults to your portal’s home currency. To find valid currency codes: go to Settings > Account defaults > Currencies to see your enabled currencies. Common codes include ‘USD’ and ‘EUR’, but availability depends on your portal configuration.
string
Forecasted amount (‘Amount’ * ‘hs_deal_stage_probability’; HubSpot-calculated).
string
Original deal source per HubSpot analytics (e.g., ‘Organic Search’; typically read-only).
string
Date/time deal last modified (ISO 8601, read-only, HubSpot-updated).
string
Projected deal amount (manually set or calculated).
string
Deal’s value in company’s home currency (read-only, HubSpot-calculated).
string
Sales forecasting probability; may differ from ‘hs_deal_stage_probability’.
string
Win probability (decimal, e.g., 0.5) based on current stage; typically stage-defined.
string
Semicolon-separated list of team IDs with access (typically read-only).
string
Date/time of last booked meeting for this deal (typically read-only).
string
Semicolon-separated list of assigned business unit IDs (for Business Units add-on).
string
Closed amount in home currency (HubSpot-calculated).
string
Projected amount in home currency (HubSpot-calculated).
string
Medium (e.g., ‘Meetings’) of last booked meeting (typically read-only).
string
Source (e.g., ‘Calendar’) of last booked meeting (typically read-only).
string
Campaign ID for the last booked meeting (typically read-only).

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: HUBSPOT_CREATE_DEAL_FROM_NLCreates a HubSpot deal from a natural language description using an LLM and the deal property schema. It attempts to fetch pipeline stages for context and accepts an optional pipeline override and associations.

Input Parameters

string
required
Natural language description of the deal to create. Example: ‘New deal: Enterprise License for Acme Corp, amount $50,000, closing next month’.
string
Optional pipeline ID override. If not specified, the LLM will infer from the NL query or default to ‘default’.
array
Optional associations to create between the new deal and other CRM objects (e.g., contacts, companies). Pass-through field, not LLM-generated.

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: HUBSPOT_CREATE_DEALSCreates multiple deals in HubSpot CRM; ensure any associated object IDs, deal stages, and pipeline IDs specified are valid and exist within the HubSpot account.

Input Parameters

array
required
List of deal objects to create, each defining its properties and associations with other CRM objects.

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: HUBSPOT_CREATE_DEFAULT_ASSOCIATIONCreate HubSpot’s default unlabeled association between two CRM records.

Input Parameters

string
required
ID of the existing target CRM record.
string
required
ID of the existing source CRM record.
string
required
Target CRM object type, such as contacts or companies.
string
required
Source CRM object type, such as deals, contacts, companies, or tickets.

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: HUBSPOT_CREATE_EMAILCreates a new HubSpot email engagement record. REQUIRED FIELDS in properties dict: - hs_email_subject: Subject line - hs_email_html: HTML content - hs_timestamp: Unix timestamp in milliseconds - hs_email_direction: One of ‘EMAIL’, ‘INCOMING_EMAIL’, ‘FORWARDED_EMAIL’, ‘DRAFT_EMAIL’ This creates an email engagement/activity record in HubSpot CRM, not a marketing email.

Input Parameters

object
required
Email properties to set. Keys are HubSpot internal property names. REQUIRED fields: ‘hs_email_subject’ (subject line), ‘hs_email_html’ (HTML content), ‘hs_timestamp’ (Unix timestamp in milliseconds), ‘hs_email_direction’ (one of: ‘EMAIL’, ‘INCOMING_EMAIL’, ‘FORWARDED_EMAIL’, ‘DRAFT_EMAIL’). This creates an email engagement/activity record in HubSpot CRM.

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: HUBSPOT_CREATE_EMAILSCreates multiple HubSpot CRM email engagement records in a single batch operation using supplied email properties.

Input Parameters

array
required
List of email objects to create.

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: HUBSPOT_CREATE_ENGAGEMENTCreate a legacy EMAIL, CALL, MEETING, TASK, or NOTE engagement with optional CRM associations, attachments, and type-specific metadata.

Input Parameters

boolean
Optional active state for the engagement.
array
Deal IDs as digit strings to associate with the engagement.
object
Type-specific metadata using HubSpot’s exact keys for the selected EMAIL, CALL, MEETING, TASK, or NOTE engagement type. For NOTE, body is the note text and is limited to 65,536 characters.
string
HubSpot owner ID as a digit string.
array
Ticket IDs as digit strings to associate with the engagement.
array
Company IDs as digit strings to associate with the engagement.
array
Contact IDs as digit strings to associate with the engagement.
integer
Engagement occurrence time as Unix milliseconds.
array
HubSpot file IDs as digit strings; each is sent as an object with an integer id field.
string ("EMAIL" | "CALL" | "MEETING" | "TASK" | "NOTE")
required
Legacy engagement kind; metadata requirements vary by this value.
array
Owner IDs as digit strings to include in the associations object.

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: HUBSPOT_CREATE_EVENT_TEMPLATE_FOR_APPCreates a new event template for a HubSpot app, defining structure, custom properties (tokens), and appearance (Markdown with Handlebars) of custom timeline events for CRM objects; this template must exist before logging corresponding events.

Input Parameters

string
required
The name of the event template, unique for the app and object type.
integer
required
The unique identifier of the target HubSpot app.
array
required
Defines custom properties (tokens) for the event, which can populate CRM object properties if a token’s objectPropertyName is set.
string
required
The CRM object type this event template is associated with (e.g., ‘contacts’, ‘companies’).
string
Optional Markdown string with Handlebars templating for rendering HTML for expanded event details on the CRM timeline, using tokens for event-specific data.
string
Optional Markdown string with Handlebars templating for rendering HTML for the event header on the CRM timeline, using tokens for event-specific data.

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: HUBSPOT_CREATE_FEEDBACK_SUBMISSIONCreates a HubSpot feedback submission with properties and an associations list, which may be empty.

Input Parameters

object
required
Properties for the feedback submission. Keys are internal names (e.g., ‘hs_feedback_rating’), values must be strings. Property names must be pre-defined in your HubSpot account.
array
required
Associations between this feedback submission and other CRM objects, specifying target object ID and association types.

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: HUBSPOT_CREATE_LANDING_PAGECreate a HubSpot landing page, as a draft unless state is explicitly set.

Input Parameters

string
required
Internal name of the landing page.
string
URL path of the landing page.
string
Publication state to request, such as DRAFT or PUBLISHED_OR_SCHEDULED. Omit this field to use HubSpot’s draft default.
string
Connected HubSpot domain on which to host the landing page.
object
Page-level module data keyed by widget name.
string
GUID of the marketing campaign associated with the page.
string ("aa" | "ab" | "ae" | "af" | "af-na" | "af-za" | "agq" | "agq-cm" | "ak" | "ak-gh" | "am" | "am-et" | "an" | "ann" | "ann-ng" | "ar" | "ar-001" | "ar-ae" | "ar-bh" | "ar-dj" | "ar-dz" | "ar-eg" | "ar-eh" | "ar-er" | "ar-il" | "ar-iq" | "ar-jo" | "ar-km" | "ar-kw" | "ar-lb" | "ar-ly" | "ar-ma" | "ar-mr" | "ar-om" | "ar-ps" | "ar-qa" | "ar-sa" | "ar-sd" | "ar-so" | "ar-ss" | "ar-sy" | "ar-td" | "ar-tn" | "ar-ye" | "as" | "as-in" | "asa" | "asa-tz" | "ast" | "ast-es" | "av" | "ay" | "az" | "az-az" | "ba" | "bal" | "bal-pk" | "bas" | "bas-cm" | "be" | "be-by" | "bem" | "bem-zm" | "bez" | "bez-tz" | "bg" | "bg-bg" | "bgc" | "bgc-in" | "bho" | "bho-in" | "bi" | "blo" | "blo-bj" | "bm" | "bm-ml" | "bn" | "bn-bd" | "bn-in" | "bo" | "bo-cn" | "bo-in" | "br" | "br-fr" | "brx" | "brx-in" | "bs" | "bs-ba" | "ca" | "ca-ad" | "ca-es" | "ca-fr" | "ca-it" | "ccp" | "ccp-bd" | "ccp-in" | "ce" | "ce-ru" | "ceb" | "ceb-ph" | "cgg" | "cgg-ug" | "ch" | "chr" | "chr-us" | "ckb" | "ckb-iq" | "ckb-ir" | "co" | "cr" | "cs" | "cs-cz" | "csw" | "csw-ca" | "cu" | "cu-ru" | "cv" | "cv-ru" | "cy" | "cy-gb" | "da" | "da-dk" | "da-gl" | "dav" | "dav-ke" | "de" | "de-at" | "de-be" | "de-ch" | "de-de" | "de-gr" | "de-it" | "de-li" | "de-lu" | "dje" | "dje-ne" | "doi" | "doi-in" | "dsb" | "dsb-de" | "dua" | "dua-cm" | "dv" | "dyo" | "dyo-sn" | "dz" | "dz-bt" | "ebu" | "ebu-ke" | "ee" | "ee-gh" | "ee-tg" | "el" | "el-cy" | "el-gr" | "en" | "en-001" | "en-150" | "en-ae" | "en-ag" | "en-ai" | "en-as" | "en-at" | "en-au" | "en-bb" | "en-be" | "en-bi" | "en-bm" | "en-bs" | "en-bw" | "en-bz" | "en-ca" | "en-cc" | "en-ch" | "en-ck" | "en-cm" | "en-cn" | "en-cx" | "en-cy" | "en-cz" | "en-de" | "en-dg" | "en-dk" | "en-dm" | "en-ee" | "en-eg" | "en-er" | "en-es" | "en-fi" | "en-fj" | "en-fk" | "en-fm" | "en-fr" | "en-gb" | "en-gd" | "en-gg" | "en-gh" | "en-gi" | "en-gm" | "en-gs" | "en-gu" | "en-gy" | "en-hk" | "en-hu" | "en-id" | "en-ie" | "en-il" | "en-im" | "en-in" | "en-io" | "en-it" | "en-je" | "en-jm" | "en-ke" | "en-ki" | "en-kn" | "en-ky" | "en-lc" | "en-lr" | "en-ls" | "en-lu" | "en-mg" | "en-mh" | "en-mo" | "en-mp" | "en-ms" | "en-mt" | "en-mu" | "en-mv" | "en-mw" | "en-mx" | "en-my" | "en-na" | "en-nf" | "en-ng" | "en-nl" | "en-no" | "en-nr" | "en-nu" | "en-nz" | "en-pg" | "en-ph" | "en-pk" | "en-pl" | "en-pn" | "en-pr" | "en-pt" | "en-pw" | "en-ro" | "en-rw" | "en-sb" | "en-sc" | "en-sd" | "en-se" | "en-sg" | "en-sh" | "en-si" | "en-sk" | "en-sl" | "en-ss" | "en-sx" | "en-sz" | "en-tc" | "en-th" | "en-tk" | "en-tn" | "en-to" | "en-tt" | "en-tv" | "en-tz" | "en-ug" | "en-um" | "en-us" | "en-vc" | "en-vg" | "en-vi" | "en-vn" | "en-vu" | "en-ws" | "en-za" | "en-zm" | "en-zw" | "eo" | "eo-001" | "es" | "es-419" | "es-ar" | "es-bo" | "es-br" | "es-bz" | "es-cl" | "es-co" | "es-cr" | "es-cu" | "es-do" | "es-ea" | "es-ec" | "es-es" | "es-gq" | "es-gt" | "es-hn" | "es-ic" | "es-mx" | "es-ni" | "es-pa" | "es-pe" | "es-ph" | "es-pr" | "es-py" | "es-sv" | "es-us" | "es-uy" | "es-ve" | "et" | "et-ee" | "eu" | "eu-es" | "ewo" | "ewo-cm" | "fa" | "fa-af" | "fa-ir" | "ff" | "ff-bf" | "ff-cm" | "ff-gh" | "ff-gm" | "ff-gn" | "ff-gw" | "ff-lr" | "ff-mr" | "ff-ne" | "ff-ng" | "ff-sl" | "ff-sn" | "fi" | "fi-fi" | "fil" | "fil-ph" | "fj" | "fo" | "fo-dk" | "fo-fo" | "fr" | "fr-be" | "fr-bf" | "fr-bi" | "fr-bj" | "fr-bl" | "fr-ca" | "fr-cd" | "fr-cf" | "fr-cg" | "fr-ch" | "fr-ci" | "fr-cm" | "fr-dj" | "fr-dz" | "fr-fr" | "fr-ga" | "fr-gf" | "fr-gn" | "fr-gp" | "fr-gq" | "fr-ht" | "fr-km" | "fr-lu" | "fr-ma" | "fr-mc" | "fr-mf" | "fr-mg" | "fr-ml" | "fr-mq" | "fr-mr" | "fr-mu" | "fr-nc" | "fr-ne" | "fr-pf" | "fr-pm" | "fr-re" | "fr-rw" | "fr-sc" | "fr-sn" | "fr-sy" | "fr-td" | "fr-tg" | "fr-tn" | "fr-vu" | "fr-wf" | "fr-yt" | "frr" | "frr-de" | "fur" | "fur-it" | "fy" | "fy-nl" | "ga" | "ga-gb" | "ga-ie" | "gaa" | "gaa-gh" | "gd" | "gd-gb" | "gl" | "gl-es" | "gn" | "gsw" | "gsw-ch" | "gsw-fr" | "gsw-li" | "gu" | "gu-in" | "guz" | "guz-ke" | "gv" | "gv-im" | "ha" | "ha-gh" | "ha-ne" | "ha-ng" | "haw" | "haw-us" | "he" | "he-il" | "hi" | "hi-in" | "hmn" | "ho" | "hr" | "hr-ba" | "hr-hr" | "hsb" | "hsb-de" | "ht" | "ht-ht" | "hu" | "hu-hu" | "hy" | "hy-am" | "hz" | "ia" | "ia-001" | "id" | "id-id" | "ie" | "ie-ee" | "ig" | "ig-ng" | "ii" | "ii-cn" | "ik" | "io" | "is" | "is-is" | "it" | "it-ch" | "it-it" | "it-sm" | "it-va" | "iu" | "ja" | "ja-jp" | "jgo" | "jgo-cm" | "jmc" | "jmc-tz" | "jv" | "jv-id" | "ka" | "ka-ge" | "kab" | "kab-dz" | "kam" | "kam-ke" | "kar" | "kde" | "kde-tz" | "kea" | "kea-cv" | "kg" | "kgp" | "kgp-br" | "kh" | "khq" | "khq-ml" | "ki" | "ki-ke" | "kj" | "kk" | "kk-kz" | "kkj" | "kkj-cm" | "kl" | "kl-gl" | "kln" | "kln-ke" | "km" | "km-kh" | "kn" | "kn-in" | "ko" | "ko-cn" | "ko-kp" | "ko-kr" | "kok" | "kok-in" | "kr" | "ks" | "ks-in" | "ksb" | "ksb-tz" | "ksf" | "ksf-cm" | "ksh" | "ksh-de" | "ku" | "ku-tr" | "kv" | "kw" | "kw-gb" | "kxv" | "kxv-in" | "ky" | "ky-kg" | "la" | "lag" | "lag-tz" | "lb" | "lb-lu" | "lg" | "lg-ug" | "li" | "lij" | "lij-it" | "lkt" | "lkt-us" | "lmo" | "lmo-it" | "ln" | "ln-ao" | "ln-cd" | "ln-cf" | "ln-cg" | "lo" | "lo-la" | "lrc" | "lrc-iq" | "lrc-ir" | "lt" | "lt-lt" | "lu" | "lu-cd" | "luo" | "luo-ke" | "luy" | "luy-ke" | "lv" | "lv-lv" | "mai" | "mai-in" | "mas" | "mas-ke" | "mas-tz" | "mdf" | "mdf-ru" | "mer" | "mer-ke" | "mfe" | "mfe-mu" | "mg" | "mg-mg" | "mgh" | "mgh-mz" | "mgo" | "mgo-cm" | "mh" | "mi" | "mi-nz" | "mk" | "mk-mk" | "ml" | "ml-in" | "mn" | "mn-mn" | "mni" | "mni-in" | "mr" | "mr-in" | "ms" | "ms-bn" | "ms-id" | "ms-my" | "ms-sg" | "mt" | "mt-mt" | "mua" | "mua-cm" | "my" | "my-mm" | "mzn" | "mzn-ir" | "na" | "naq" | "naq-na" | "nb" | "nb-no" | "nb-sj" | "nd" | "nd-zw" | "nds" | "nds-de" | "nds-nl" | "ne" | "ne-in" | "ne-np" | "ng" | "nl" | "nl-aw" | "nl-be" | "nl-bq" | "nl-ch" | "nl-cw" | "nl-lu" | "nl-nl" | "nl-sr" | "nl-sx" | "nmg" | "nmg-cm" | "nn" | "nn-no" | "nnh" | "nnh-cm" | "no" | "no-no" | "nqo" | "nqo-gn" | "nr" | "nso" | "nso-za" | "nus" | "nus-ss" | "nv" | "ny" | "nyn" | "nyn-ug" | "oc" | "oc-es" | "oc-fr" | "oj" | "om" | "om-et" | "om-ke" | "or" | "or-in" | "os" | "os-ge" | "os-ru" | "pa" | "pa-in" | "pa-pk" | "pcm" | "pcm-ng" | "pi" | "pis" | "pis-sb" | "pl" | "pl-pl" | "prg" | "prg-001" | "ps" | "ps-af" | "ps-pk" | "pt" | "pt-ao" | "pt-br" | "pt-ch" | "pt-cv" | "pt-gq" | "pt-gw" | "pt-lu" | "pt-mo" | "pt-mz" | "pt-pt" | "pt-st" | "pt-tl" | "qu" | "qu-bo" | "qu-ec" | "qu-pe" | "raj" | "raj-in" | "rm" | "rm-ch" | "rn" | "rn-bi" | "ro" | "ro-md" | "ro-ro" | "rof" | "rof-tz" | "ru" | "ru-by" | "ru-kg" | "ru-kz" | "ru-md" | "ru-ru" | "ru-ua" | "rw" | "rw-rw" | "rwk" | "rwk-tz" | "sa" | "sa-in" | "sah" | "sah-ru" | "saq" | "saq-ke" | "sat" | "sat-in" | "sbp" | "sbp-tz" | "sc" | "sc-it" | "sd" | "sd-in" | "sd-pk" | "se" | "se-fi" | "se-no" | "se-se" | "seh" | "seh-mz" | "ses" | "ses-ml" | "sg" | "sg-cf" | "shi" | "shi-ma" | "si" | "si-lk" | "sk" | "sk-sk" | "sl" | "sl-si" | "sm" | "smn" | "smn-fi" | "sms" | "sms-fi" | "sn" | "sn-zw" | "so" | "so-dj" | "so-et" | "so-ke" | "so-so" | "sq" | "sq-al" | "sq-mk" | "sq-xk" | "sr" | "sr-ba" | "sr-cs" | "sr-me" | "sr-rs" | "sr-xk" | "ss" | "st" | "st-ls" | "st-za" | "su" | "su-id" | "sv" | "sv-ax" | "sv-fi" | "sv-se" | "sw" | "sw-cd" | "sw-ke" | "sw-tz" | "sw-ug" | "sy" | "syr" | "syr-iq" | "syr-sy" | "szl" | "szl-pl" | "ta" | "ta-in" | "ta-lk" | "ta-my" | "ta-sg" | "te" | "te-in" | "teo" | "teo-ke" | "teo-ug" | "tg" | "tg-tj" | "th" | "th-th" | "ti" | "ti-er" | "ti-et" | "tk" | "tk-tm" | "tl" | "tn" | "tn-bw" | "tn-za" | "to" | "to-to" | "tok" | "tok-001" | "tr" | "tr-cy" | "tr-tr" | "ts" | "tt" | "tt-ru" | "tw" | "twq" | "twq-ne" | "ty" | "tzm" | "tzm-ma" | "ug" | "ug-cn" | "uk" | "uk-ua" | "ur" | "ur-in" | "ur-pk" | "uz" | "uz-af" | "uz-uz" | "vai" | "vai-lr" | "ve" | "vec" | "vec-it" | "vi" | "vi-vn" | "vmw" | "vmw-mz" | "vo" | "vo-001" | "vun" | "vun-tz" | "wa" | "wae" | "wae-ch" | "wo" | "wo-sn" | "xh" | "xh-za" | "xnr" | "xnr-in" | "xog" | "xog-ug" | "yav" | "yav-cm" | "yi" | "yi-001" | "yi-ua" | "yo" | "yo-bj" | "yo-ng" | "yrl" | "yrl-br" | "yrl-co" | "yrl-ve" | "yue" | "yue-cn" | "yue-hk" | "yue-mo" | "za" | "za-cn" | "zgh" | "zgh-ma" | "zh" | "zh-cn" | "zh-hans" | "zh-hant" | "zh-hk" | "zh-mo" | "zh-my" | "zh-sg" | "zh-tw" | "zu" | "zu-za")
ISO 639 language code; omit to use the connected domain’s language.
string
HubSpot dashboard folder ID in which to organize the page.
string
Custom HTML inserted in the page’s head element.
string
HTML title shown in the browser and search results.
Custom HTML inserted before the page’s closing body tag.
string ("landing_page" | "site_page")
HubSpot page subcategory.
string
ISO 8601 date and time at which the page is to be published.
object
Language variations keyed by HubSpot language code.
string
required
Path of the HubSpot template to use for the landing page. Do not include a leading slash.
URL of the page’s featured image.
object
Complete drag-and-drop layout section definitions keyed by section name.
string
Description placed in the page’s HTML meta tag.
integer
Date at which the page expires and begins redirecting.
object
Module data for the page’s flexible columns, keyed by container.
string
ID of the primary page from which this translation was created.
Whether the page should use featured_image.
boolean
Whether page expiration and redirection are enabled.
array
Member-registration access rules for private page content.
boolean
Whether a later schedule operation should publish immediately and ignore publish_date.
array
Ordered stylesheet definitions to attach only to this page.
string
Password visitors must enter to view a password-protected page. The value is masked in the request model and sent to HubSpot as password.
object
Theme-specific settings to apply to the landing page.
URL to place in the page’s rel=canonical link tag.
Alternative text for the featured image.
string
HubSpot page ID to redirect to after expiry, represented as a string to preserve 64-bit precision; do not combine with page_expiry_redirect_url.
string
External URL to redirect to after expiry; do not combine with page_expiry_redirect_id.
boolean
Whether to apply stylesheets configured for the page’s domain.
boolean
Whether to apply stylesheets from the page template.
boolean
Whether to apply the account’s primary CSS files.
string
Identifier of the data source used by the dynamic page.
boolean
Whether HubSpot should enforce public_access_rules.
string
HubDB table ID used as the dynamic page data source.
integer
Provider numeric type of the dynamic page data source.

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: HUBSPOT_CREATE_LINE_ITEMCreates a new HubSpot line item.

Input Parameters

object
required
Line item properties to set. Keys are HubSpot internal property names.

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: HUBSPOT_CREATE_LINE_ITEMSCreates multiple HubSpot line items in a single batch operation.

Input Parameters

array
required
List of line item objects to create.

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: HUBSPOT_CREATE_LISTCreate a HubSpot CRM list with manual, snapshot, or dynamic membership rules.

Input Parameters

string
required
Portal-wide unique list name.
object
Recursive HubSpot filter branch for a DYNAMIC list. Use exact provider keys such as filterBranchType, filterBranches, filters, filterType, property, and operation. The full grammar is polymorphic and supports OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS, and ASSOCIATION branches.
integer
Folder ID in which to place the list. Must be non-negative.
string
required
CRM object type ID whose records can become members, such as 0-1 for contacts.
string ("SNAPSHOT" | "MANUAL" | "DYNAMIC")
required
How HubSpot determines and refreshes list membership.
object
Permissions object using exact teamsWithEditAccess and usersWithEditAccess wire keys.
object
Optional custom list properties keyed by exact HubSpot property name.
object
Membership settings using exact includeUnassigned and membershipTeamId wire keys.

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: HUBSPOT_CREATE_MEETINGCreates a new meeting engagement in HubSpot CRM. Use this action when you need to log a meeting that occurred or schedule a future meeting with contacts, companies, or other CRM records. The meeting will appear on the timeline of associated records and can include details like title, time, location, notes, and outcome.

Input Parameters

array
List of associations to link this meeting with other CRM objects like contacts, companies, or deals.
string
required
The date and time when the meeting occurred, in Unix timestamp (milliseconds) or ISO 8601 format. This is the only required field and defaults to hs_meeting_start_time if that is provided.
string
Description or notes about the meeting content and agenda.
string
Meeting classification or activity type based on your HubSpot account settings.
string
The title or name of the meeting.
string
The ID of the HubSpot user who owns or created this meeting.
object
Additional custom properties as key-value pairs using the property’s internal name as the key.
string
Semicolon-separated list of attachment IDs to associate with the meeting.
string ("SCHEDULED" | "COMPLETED" | "RESCHEDULED" | "NO_SHOW" | "CANCELED")
Outcome status for a meeting engagement.
string
The scheduled end time of the meeting, in Unix timestamp (milliseconds) or ISO 8601 format.
string
The location of the meeting (physical address, conference room, video link, or phone number).
string
The scheduled start time of the meeting, in Unix timestamp (milliseconds) or ISO 8601 format. Should match hs_timestamp.
string
External URL to the calendar event (Google Calendar, Outlook, etc.).
string
Internal notes for your team about the meeting, not visible to external attendees.

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: HUBSPOT_CREATE_NOTECreates a new HubSpot CRM note. Use when you need to add a timestamped note with optional attachments and associations to contacts, companies, deals, or tickets.

Input Parameters

array
List of associations to link with the note (e.g., contacts, deals, companies).
string
Text content of the note (up to 65,536 characters).
string
required
Creation time of the note. Either an ISO-8601 UTC timestamp (e.g., ‘2021-11-12T15:48:22Z’) or Unix milliseconds since epoch.
string
HubSpot user ID to assign as the creator/owner of this note.
object
A dictionary of custom properties. Boolean-type fields accept ‘Yes’/‘No’, ‘true’/‘false’, ‘on’/‘off’, ‘y’/‘n’ and Python booleans, which are auto-converted to string values (‘true’/‘false’) for HubSpot API compatibility. Numeric strings (‘0’, ‘1’, ‘2’, etc.) are preserved as-is for number fields.
string
Semicolon-separated list of file attachment IDs.

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: HUBSPOT_CREATE_OBJECT_ASSOCIATIONTool to create or label an association between two CRM records using HubSpot Associations v4 API. Use when you need to link records (e.g., contact to company, deal to contact) with explicit association labels.

Input Parameters

array
required
Array of association label descriptors defining the type(s) of relationship between the two records. Each label includes an associationCategory and associationTypeId.
string
required
The unique ID of the source CRM record.
string
required
The type of the source object (e.g., ‘contacts’, ‘companies’, ‘deals’, ‘tickets’, or a custom object type).
string
required
The unique ID of the target CRM record to associate with.
string
required
The type of the target object to associate with (e.g., ‘contacts’, ‘companies’, ‘deals’, ‘tickets’, or a custom object type).

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: HUBSPOT_CREATE_OBJECT_SCHEMACreates a new custom object schema in HubSpot CRM with unique naming for schema and properties, defined display/required/searchable properties within the ‘properties’ list, provided immutable labels, and correctly configured ‘enumeration’ type properties (options/referencedObjectType).

Input Parameters

string
required
Unique, immutable programmatic name for the schema (used in API calls); must be unique in the account.
array
required
List of property definitions for this custom object schema.
string
Optional human-readable description for the custom object schema.
string
Plural display name used in HubSpot UI; immutable after creation.
string
Singular display name used in HubSpot UI; immutable after creation.
array
required
Object type IDs (e.g., ‘CONTACT’, ‘COMPANY’, ‘p123456’) this schema can be associated with.
array
required
Internal names of properties required for new records; must be defined in ‘properties’.
array
Internal names of properties indexed for global search; must be defined in ‘properties’.
string
Internal name of the primary identifier property; must be defined in ‘properties’.
array
Internal names of properties for secondary display on record pages; must be defined in ‘properties’.

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: HUBSPOT_CREATE_OR_UPDATE_DRAFT_VERSIONCreates or updates the draft version of a marketing email identified by emailId; if no draft exists, a new one is created from the current live version to prepare changes or A/B tests before publishing.

Input Parameters

string
Internal name of the email for HubSpot dashboard.
string ("AUTOMATED" | "AUTOMATED_DRAFT" | "AUTOMATED_SENDING" | "AUTOMATED_FOR_FORM" | "AUTOMATED_FOR_FORM_BUFFER" | "AUTOMATED_FOR_FORM_DRAFT" | "AUTOMATED_FOR_FORM_LEGACY" | "BLOG_EMAIL_DRAFT" | "BLOG_EMAIL_PUBLISHED" | "DRAFT" | "DRAFT_AB" | "DRAFT_AB_VARIANT" | "ERROR" | "LOSER_AB_VARIANT" | "PAGE_STUB" | "PRE_PROCESSING" | "PROCESSING" | "PUBLISHED" | "PUBLISHED_AB" | "PUBLISHED_AB_VARIANT" | "PUBLISHED_OR_SCHEDULED" | "RSS_TO_EMAIL_DRAFT" | "RSS_TO_EMAIL_PUBLISHED" | "SCHEDULED" | "SCHEDULED_AB" | "SCHEDULED_OR_PUBLISHED" | "AUTOMATED_AB" | "AUTOMATED_AB_VARIANT" | "AUTOMATED_DRAFT_AB" | "AUTOMATED_DRAFT_ABVARIANT" | "AUTOMATED_LOSER_ABVARIANT")
Current state of the email (e.g., ‘DRAFT’); typically system-managed.
string
required
The unique identifier of the marketing email.
string
The subject line of the email.
boolean
Indicates if the marketing email is archived.
string
Associated HubSpot campaign ID for tracking/reporting.
string ("af" | "af-na" | "af-za" | "agq" | "agq-cm" | "ak" | "ak-gh" | "am" | "am-et" | "ar" | "ar-001" | "ar-ae" | "ar-bh" | "ar-dj" | "ar-dz" | "ar-eg" | "ar-eh" | "ar-er" | "ar-il" | "ar-iq" | "ar-jo" | "ar-km" | "ar-kw" | "ar-lb" | "ar-ly" | "ar-ma" | "ar-mr" | "ar-om" | "ar-ps" | "ar-qa" | "ar-sa" | "ar-sd" | "ar-so" | "ar-ss" | "ar-sy" | "ar-td" | "ar-tn" | "ar-ye" | "as" | "as-in" | "asa" | "asa-tz" | "ast" | "ast-es" | "az" | "az-az" | "bas" | "bas-cm" | "be" | "be-by" | "bem" | "bem-zm" | "bez" | "bez-tz" | "bg" | "bg-bg" | "bm" | "bm-ml" | "bn" | "bn-bd" | "bn-in" | "bo" | "bo-cn" | "bo-in" | "br" | "br-fr" | "brx" | "brx-in" | "bs" | "bs-ba" | "ca" | "ca-ad" | "ca-es" | "ca-fr" | "ca-it" | "ccp" | "ccp-bd" | "ccp-in" | "ce" | "ce-ru" | "ceb" | "ceb-ph" | "cgg" | "cgg-ug" | "chr" | "chr-us" | "ckb" | "ckb-iq" | "ckb-ir" | "cs" | "cs-cz" | "cu" | "cu-ru" | "cy" | "cy-gb" | "da" | "da-dk" | "da-gl" | "dav" | "dav-ke" | "de" | "de-at" | "de-be" | "de-ch" | "de-de" | "de-gr" | "de-it" | "de-li" | "de-lu" | "dje" | "dje-ne" | "doi" | "doi-in" | "dsb" | "dsb-de" | "dua" | "dua-cm" | "dyo" | "dyo-sn" | "dz" | "dz-bt" | "ebu" | "ebu-ke" | "ee" | "ee-gh" | "ee-tg" | "el" | "el-cy" | "el-gr" | "en" | "en-001" | "en-150" | "en-ae" | "en-ag" | "en-ai" | "en-as" | "en-at" | "en-au" | "en-bb" | "en-be" | "en-bi" | "en-bm" | "en-bs" | "en-bw" | "en-bz" | "en-ca" | "en-cc" | "en-ch" | "en-ck" | "en-cm" | "en-cn" | "en-cx" | "en-cy" | "en-de" | "en-dg" | "en-dk" | "en-dm" | "en-er" | "en-fi" | "en-fj" | "en-fk" | "en-fm" | "en-gb" | "en-gd" | "en-gg" | "en-gh" | "en-gi" | "en-gm" | "en-gu" | "en-gy" | "en-hk" | "en-ie" | "en-il" | "en-im" | "en-in" | "en-io" | "en-je" | "en-jm" | "en-ke" | "en-ki" | "en-kn" | "en-ky" | "en-lc" | "en-lr" | "en-ls" | "en-lu" | "en-mg" | "en-mh" | "en-mo" | "en-mp" | "en-ms" | "en-mt" | "en-mu" | "en-mw" | "en-mx" | "en-my" | "en-na" | "en-nf" | "en-ng" | "en-nl" | "en-nr" | "en-nu" | "en-nz" | "en-pg" | "en-ph" | "en-pk" | "en-pn" | "en-pr" | "en-pw" | "en-rw" | "en-sb" | "en-sc" | "en-sd" | "en-se" | "en-sg" | "en-sh" | "en-si" | "en-sl" | "en-ss" | "en-sx" | "en-sz" | "en-tc" | "en-tk" | "en-to" | "en-tt" | "en-tv" | "en-tz" | "en-ug" | "en-um" | "en-us" | "en-vc" | "en-vg" | "en-vi" | "en-vu" | "en-ws" | "en-za" | "en-zm" | "en-zw" | "eo" | "eo-001" | "es" | "es-419" | "es-ar" | "es-bo" | "es-br" | "es-bz" | "es-cl" | "es-co" | "es-cr" | "es-cu" | "es-do" | "es-ea" | "es-ec" | "es-es" | "es-gq" | "es-gt" | "es-hn" | "es-ic" | "es-mx" | "es-ni" | "es-pa" | "es-pe" | "es-ph" | "es-pr" | "es-py" | "es-sv" | "es-us" | "es-uy" | "es-ve" | "et" | "et-ee" | "eu" | "eu-es" | "ewo" | "ewo-cm" | "fa" | "fa-af" | "fa-ir" | "ff" | "ff-bf" | "ff-cm" | "ff-gh" | "ff-gm" | "ff-gn" | "ff-gw" | "ff-lr" | "ff-mr" | "ff-ne" | "ff-ng" | "ff-sl" | "ff-sn" | "fi" | "fi-fi" | "fil" | "fil-ph" | "fo" | "fo-dk" | "fo-fo" | "fr" | "fr-be" | "fr-bf" | "fr-bi" | "fr-bj" | "fr-bl" | "fr-ca" | "fr-cd" | "fr-cf" | "fr-cg" | "fr-ch" | "fr-ci" | "fr-cm" | "fr-dj" | "fr-dz" | "fr-fr" | "fr-ga" | "fr-gf" | "fr-gn" | "fr-gp" | "fr-gq" | "fr-ht" | "fr-km" | "fr-lu" | "fr-ma" | "fr-mc" | "fr-mf" | "fr-mg" | "fr-ml" | "fr-mq" | "fr-mr" | "fr-mu" | "fr-nc" | "fr-ne" | "fr-pf" | "fr-pm" | "fr-re" | "fr-rw" | "fr-sc" | "fr-sn" | "fr-sy" | "fr-td" | "fr-tg" | "fr-tn" | "fr-vu" | "fr-wf" | "fr-yt" | "fur" | "fur-it" | "fy" | "fy-nl" | "ga" | "ga-gb" | "ga-ie" | "gd" | "gd-gb" | "gl" | "gl-es" | "gsw" | "gsw-ch" | "gsw-fr" | "gsw-li" | "gu" | "gu-in" | "guz" | "guz-ke" | "gv" | "gv-im" | "ha" | "ha-gh" | "ha-ne" | "ha-ng" | "haw" | "haw-us" | "he" | "hi" | "hi-in" | "hr" | "hr-ba" | "hr-hr" | "hsb" | "hsb-de" | "hu" | "hu-hu" | "hy" | "hy-am" | "ia" | "ia-001" | "id" | "ig" | "ig-ng" | "ii" | "ii-cn" | "id-id" | "is" | "is-is" | "it" | "it-ch" | "it-it" | "it-sm" | "it-va" | "he-il" | "ja" | "ja-jp" | "jgo" | "jgo-cm" | "yi" | "yi-001" | "jmc" | "jmc-tz" | "jv" | "jv-id" | "ka" | "ka-ge" | "kab" | "kab-dz" | "kam" | "kam-ke" | "kde" | "kde-tz" | "kea" | "kea-cv" | "khq" | "khq-ml" | "ki" | "ki-ke" | "kk" | "kk-kz" | "kkj" | "kkj-cm" | "kl" | "kl-gl" | "kln" | "kln-ke" | "km" | "km-kh" | "kn" | "kn-in" | "ko" | "ko-kp" | "ko-kr" | "kok" | "kok-in" | "ks" | "ks-in" | "ksb" | "ksb-tz" | "ksf" | "ksf-cm" | "ksh" | "ksh-de" | "kw" | "kw-gb" | "ku" | "ku-tr" | "ky" | "ky-kg" | "lag" | "lag-tz" | "lb" | "lb-lu" | "lg" | "lg-ug" | "lkt" | "lkt-us" | "ln" | "ln-ao" | "ln-cd" | "ln-cf" | "ln-cg" | "lo" | "lo-la" | "lrc" | "lrc-iq" | "lrc-ir" | "lt" | "lt-lt" | "lu" | "lu-cd" | "luo" | "luo-ke" | "luy" | "luy-ke" | "lv" | "lv-lv" | "mai" | "mai-in" | "mas" | "mas-ke" | "mas-tz" | "mer" | "mer-ke" | "mfe" | "mfe-mu" | "mg" | "mg-mg" | "mgh" | "mgh-mz" | "mgo" | "mgo-cm" | "mi" | "mi-nz" | "mk" | "mk-mk" | "ml" | "ml-in" | "mn" | "mn-mn" | "mni" | "mni-in" | "mr" | "mr-in" | "ms" | "ms-bn" | "ms-id" | "ms-my" | "ms-sg" | "mt" | "mt-mt" | "mua" | "mua-cm" | "my" | "my-mm" | "mzn" | "mzn-ir" | "naq" | "naq-na" | "nb" | "nb-no" | "nb-sj" | "nd" | "nd-zw" | "nds" | "nds-de" | "nds-nl" | "ne" | "ne-in" | "ne-np" | "nl" | "nl-aw" | "nl-be" | "nl-ch" | "nl-bq" | "nl-cw" | "nl-lu" | "nl-nl" | "nl-sr" | "nl-sx" | "nmg" | "nmg-cm" | "nn" | "nn-no" | "nnh" | "nnh-cm" | "no" | "no-no" | "nus" | "nus-ss" | "nyn" | "nyn-ug" | "om" | "om-et" | "om-ke" | "or" | "or-in" | "os" | "os-ge" | "os-ru" | "pa" | "pa-in" | "pa-pk" | "pcm" | "pcm-ng" | "pl" | "pl-pl" | "prg" | "prg-001" | "ps" | "ps-af" | "ps-pk" | "pt" | "pt-ao" | "pt-br" | "pt-ch" | "pt-cv" | "pt-gq" | "pt-gw" | "pt-lu" | "pt-mo" | "pt-mz" | "pt-pt" | "pt-st" | "pt-tl" | "qu" | "qu-bo" | "qu-ec" | "qu-pe" | "rm" | "rm-ch" | "rn" | "rn-bi" | "ro" | "ro-md" | "ro-ro" | "rof" | "rof-tz" | "ru" | "ru-by" | "ru-kg" | "ru-kz" | "ru-md" | "ru-ru" | "ru-ua" | "rw" | "rw-rw" | "rwk" | "rwk-tz" | "sa" | "sa-in" | "sah" | "sah-ru" | "saq" | "saq-ke" | "sat" | "sat-in" | "sbp" | "sbp-tz" | "sd" | "sd-in" | "sd-pk" | "se" | "se-fi" | "se-no" | "se-se" | "seh" | "seh-mz" | "ses" | "ses-ml" | "sg" | "sg-cf" | "shi" | "shi-ma" | "si" | "si-lk" | "sk" | "sk-sk" | "sl" | "sl-si" | "smn" | "smn-fi" | "sn" | "sn-zw" | "so" | "so-dj" | "so-et" | "so-ke" | "so-so" | "sq" | "sq-al" | "sq-mk" | "sq-xk" | "sr" | "sr-ba" | "sr-cs" | "sr-me" | "sr-rs" | "sr-xk" | "su" | "su-id" | "sv" | "sv-ax" | "sv-fi" | "sv-se" | "sw" | "sw-cd" | "sw-ke" | "sw-tz" | "sw-ug" | "sy" | "ta" | "ta-in" | "ta-lk" | "ta-my" | "ta-sg" | "te" | "te-in" | "teo" | "teo-ke" | "teo-ug" | "tg" | "tg-tj" | "th" | "th-th" | "ti" | "ti-er" | "ti-et" | "tk" | "tk-tm" | "tl" | "to" | "to-to" | "tr" | "tr-cy" | "tr-tr" | "tt" | "tt-ru" | "twq" | "twq-ne" | "tzm" | "tzm-ma" | "ug" | "ug-cn" | "uk" | "uk-ua" | "ur" | "ur-in" | "ur-pk" | "uz" | "uz-af" | "uz-uz" | "vai" | "vai-lr" | "vi" | "vi-vn" | "vo" | "vo-001" | "vun" | "vun-tz" | "wae" | "wae-ch" | "wo" | "wo-sn" | "xh" | "xh-za" | "xog" | "xog-ug" | "yav" | "yav-cm" | "yo" | "yo-bj" | "yo-ng" | "yue" | "yue-cn" | "yue-hk" | "zgh" | "zgh-ma" | "zh" | "zh-cn" | "zh-hk" | "zh-mo" | "zh-sg" | "zh-tw" | "zh-hans" | "zh-hant" | "zu" | "zu-za")
Primary language of email content (e.g., ‘en’, ‘en-us’).
string
Scheduled send date/time (ISO 8601). Used for scheduled emails.
string
Email subcategory for organization/reporting (e.g., ‘MARKETING_EMAIL’).
string
Connected and verified sending domain in HubSpot.
string
External RSS feed URL. Required for external blog RSS emails.
string
‘From’ email address; receives replies if customReplyTo is not set.
boolean
If true, sends email immediately on publishing, overriding publishDate.
string
Associated business unit ID, for accounts with multiple units.
string
‘From’ name displayed to recipients.
object
Send timing for RSS emails. Applies if rssData is configured.
string
Unique identifier of the A/B test, if applicable.
object
Configuration for widgets (modules) in email content.
string
URL slug for the web version (e.g., ‘july-newsletter’).
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Current status of the A/B test.
string
Browser tab title for the web version.
object
Configuration for flexible content areas in the email template.
string
Domain for the email web version; defaults to HubSpot domain if unspecified.
string
Custom reply-to email address; overrides replyTo.
string
Layout style for blog posts in RSS email. Applies if rssData is configured.
integer
Maximum blog posts per RSS email. Applies if rssData is configured.
object
Smart fields and values for email personalization.
integer
Hours to wait for A/B test results before sending the winning version.
boolean
If true, suppresses sending to ‘graymail’ contacts.
string
Path to the email template in HubSpot Design Manager.
string
Expiration date/time (ISO 8601) for the web version link.
string
Type of RSS email (e.g., ‘instant’, ‘daily’, ‘weekly’). Applies if rssData is configured.
string
HubSpot-hosted blog ID for RSS-to-Email. Applies if rssData is configured and blog is HubSpot-hosted.
boolean
If true, respects contact send frequency limits.
array
Specific contact IDs to exclude from recipients.
array
Specific contact IDs to include as recipients.
string ("CLICKS_BY_OPENS" | "CLICKS_BY_DELIVERED" | "OPENS_BY_DELIVERED")
Metric to determine A/B test winning version (e.g., ‘CLICKS_BY_OPENS’).
string
Plain text version of the email.
object
Configuration for widget containers in the email template.
string
HTML template for each RSS entry. Applies if rssData is configured.
integer
Percentage of recipients in the A/B test group (e.g., 20 for 20%).
array
Contact list IDs whose members will be excluded.
array
Contact list IDs whose members will be included as recipients.
string
Custom URL to redirect to from web version link if redirectToPageId is not set.
integer
Maximum width for images imported from RSS feed blog posts. Applies if rssData is configured.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Default email version (‘master’ or ‘variant’) if A/B test results are inconclusive.
string
Meta description for the web version (for search engines).
object
Custom values for theme settings applied to the email template.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Default email version (‘master’ or ‘variant’) if A/B test sample size is too small.
string
HubSpot page ID to redirect to from web version link; overrides redirectToUrl.
boolean
If true, email subject is first blog post headline. Applies if rssData is configured.
string
Specific subscription type ID (e.g., newsletter).
string
Company office location ID for email footer (compliance).
string
Associated subscription preferences group ID.

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: HUBSPOT_CREATE_PIPELINECreates a new HubSpot pipeline for a specified CRM objectType (e.g., ‘deals’, ‘tickets’), requiring the pipeline label be unique for that objectType and each stage label be unique within the pipeline.

Input Parameters

string
required
A unique label for the pipeline, used for organization in the HubSpot UI for this object type.
array
required
A list of stage definitions for the new pipeline; each stage label must be unique within this pipeline.
string
required
Identifier for the CRM object type (e.g., ‘deals’, ‘tickets’, or a custom object type ID) for the new pipeline, determining its context and properties in HubSpot.
integer
required
Display order for this pipeline. Pipelines for the same object type with matching displayOrder are sorted alphabetically by label.

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: HUBSPOT_CREATE_PIPELINE_STAGECreates a new stage in a specified HubSpot CRM pipeline for a given object type, such as ‘deals’ or ‘tickets’.

Input Parameters

string
required
User-visible name for the pipeline stage, unique within the parent pipeline.
object
required
Stage-specific properties. For deals pipelines, metadata must include a probability key (value 0.0-1.0 in 0.1 increments). For tickets pipelines, an optional ticketState key can specify OPEN or CLOSED status.
string
required
CRM object type (e.g., ‘deals’, ‘tickets’) for the new stage. Must be a valid HubSpot CRM object type supporting pipelines. Typically lowercase and plural.
string
required
Identifier of the existing pipeline (specific to objectType) where the new stage will be added.
integer
required
Stage’s display order in the pipeline (lower numbers first). Stages with identical displayOrder are sorted alphabetically by label.

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: HUBSPOT_CREATE_PRODUCTCreates a new HubSpot product. Note: Products are catalog items and cannot be directly associated with deals, contacts, or companies. To connect product information to a deal or quote, create a line item using HUBSPOT_CREATE_LINE_ITEM that references this product’s ID via hs_product_id.

Input Parameters

string
The official name of the product.
number
The selling price of the product in the default currency of the HubSpot account.
string
The Stock Keeping Unit (SKU) for the product. This should be unique across all products if used for inventory management.
string
A direct URL link to the product’s page on an e-commerce website or product information site.
integer
The current quantity of the product available in inventory. This property might be relevant for physical goods.
boolean
Indicates if the product is currently active and available for sale. Set to true if active, false otherwise.
string
A comma-separated string of URLs for product images. The first URL is typically used as the primary image.
string
A detailed description of the product, its features, and benefits.
boolean
Indicates if the product has been archived. Archived products are typically hidden from active lists and sales processes. Set to true to archive.
Indicates if the product is marked as a featured item, which can be used to highlight it in product listings.
array
A list of associations to create between this new product and other CRM objects. IMPORTANT: Products CANNOT be directly associated with deals, contacts, or companies. To connect product information to a deal, create a line item using HUBSPOT_CREATE_LINE_ITEM with hs_product_id referencing this product’s ID.
string
The tax category or code applicable to the product, used for calculating sales tax (e.g., ‘Taxable Goods’, ‘Non-Taxable’).
string
An external or secondary unique identifier for the product. Useful for mapping to external systems. HubSpot does not auto-generate this.
string
The date (YYYY-MM-DD format) from which the product is considered valid or available for sale.
string
The type of the product. Valid values: ‘inventory’ (physical goods tracked in inventory), ‘non_inventory’ (physical goods not tracked), ‘service’ (services or labor).
string
The date (YYYY-MM-DD format) until which the product is considered valid or available. Leave empty if there’s no expiration date.
object
A dictionary of custom properties for the product. Keys must be internal names of custom properties that already exist in your HubSpot account. Create custom properties in HubSpot Settings > Objects > Products > Product properties before using them here. Example: {"material": "Titanium", "warranty_years": "5"}.
string
The current sales or lifecycle status of the product (e.g., ‘Available’, ‘Discontinued’, ‘Pre-order’, ‘Out of Stock’).
string
The primary category the product belongs to (e.g., ‘Electronics’, ‘Apparel’, ‘Consulting Services’).
number
The cost of goods sold (COGS) for the product. Used for profit margin calculations.
string
A more specific subcategory for the product (e.g., ‘Laptops’ under ‘Electronics’).
string
The billing frequency for recurring revenue products, formatted as a PnYnMnDTnHnMnS string (e.g., P1M for 1 month, P1Y for 1 year).

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: HUBSPOT_CREATE_PRODUCTSCreates multiple HubSpot products in a single batch operation.

Input Parameters

array
required
List of product objects to create.

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: HUBSPOT_CREATE_PROPERTY_FOR_SPECIFIED_OBJECT_TYPECreates a new custom property for a specified HubSpot CRM object type; ensure groupName refers to an existing property group for the objectType.

Input Parameters

string
required
Internal programmatic name (snake_case), unique within the objectType, used for API referencing.
string ("string" | "number" | "date" | "datetime" | "enumeration" | "bool")
required
The data type of the property.
string
required
Human-readable label for the property shown in HubSpot UI.
boolean
If true, hides property in HubSpot UI, lists, and forms. Defaults to false if not set.
array
List of predefined options. Required if type is ‘enumeration’. For fieldType of ‘booleancheckbox’, must include exactly two options with values ‘true’ and ‘false’. Each option defines a possible value.
string ("textarea" | "text" | "date" | "file" | "number" | "select" | "radio" | "checkbox" | "booleancheckbox" | "calculation_equation")
required
Controls UI display and interaction method (e.g., text input, dropdown, checkbox).
boolean
If true, property can be used in HubSpot forms. Defaults to false if not set.
string
required
Name of the property group for organization in HubSpot UI.
string
required
Target HubSpot CRM object type (e.g., contacts, companies) for the new property. Case-sensitive.
string
Optional description for the property, displayed as help text in HubSpot UI.
integer
Controls display order of properties in HubSpot UI, sorted ascending; -1 displays after positive values.
boolean
If true, property’s value must be unique across all records for the objectType. Cannot be changed to false after being set to true.
boolean
If true, ‘enumeration’ options are sourced externally, requiring referencedObjectType (e.g., ‘OWNER’ for HubSpot users). Defaults to false. Only for ‘enumeration’ type.
string
Formula for calculated property, required if fieldType is ‘calculation_equation’. Can reference other properties by their internal names.
string
For properties referencing other HubSpot objects (e.g., “OWNER” when externalOptions is true and type is “enumeration” to populate options with users). Applicable for specific property types.

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: HUBSPOT_CREATE_QUOTE_OBJECTCreates a new quote object in HubSpot CRM with specified properties and associations.

Input Parameters

object
required
A dictionary of key-value pairs representing the properties of the quote to be created. Property names are HubSpot internal names.
array
required
A list of associations to create for the new quote. Each item specifies the object to associate with and the type of association.

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: HUBSPOT_CREATE_SITE_PAGECreate a HubSpot website page draft and return its complete page record.

Input Parameters

string
required
Internal page name.
string
URL path segment for the page.
string
Connected domain for the page.
string
Page language code.
string
Custom HTML for the document head.
string
Browser and search-result title.
Custom HTML before the closing body tag.
string
Design Manager template path.
string
Search metadata description.
object
Additional documented Page fields using exact HubSpot wire names.

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: HUBSPOT_CREATE_TASKCreates a new CRM task record. Use when adding a task with properties and optional associations.

Input Parameters

array
Optional list of associations to link this task with existing CRM records.
string
Notes or body text of the task.
string ("CALL" | "EMAIL" | "TODO")
Type of the task. Defaults to TODO if not specified.
string
required
Task due date in ISO 8601 format or Unix milliseconds; required.
string ("NOT_STARTED" | "COMPLETED")
Current status of the task. Defaults to NOT_STARTED if not specified.
string
Title or subject line of the task.
string ("LOW" | "MEDIUM" | "HIGH" | "NONE")
Priority level of the task. Defaults to NONE if not specified.
string
ID of the HubSpot owner to assign this task to. This is a numeric string (typically 6-9 digits, e.g., ‘85424051’) that uniquely identifies a user in your HubSpot account. To obtain valid owner IDs, use the HUBSPOT_RETRIEVE_OWNERS action. If omitted, the task will be unassigned.
object
A dictionary of custom properties. Boolean-type fields accept ‘Yes’/‘No’, ‘true’/‘false’, ‘on’/‘off’, ‘y’/‘n’ and Python booleans, which are auto-converted to string values (‘true’/‘false’) for HubSpot API compatibility. Numeric strings (‘0’, ‘1’, ‘2’, etc.) are preserved as-is for number fields.
integer
Reminder time for the task in Unix milliseconds.

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: HUBSPOT_CREATE_TICKETCreates a new HubSpot ticket.

Input Parameters

string
Main body or description of the ticket, detailing the issue or request; typically required.
string
Subject line or title of the ticket; typically a required field.
string
ID of the HubSpot user who created the ticket.
string
Date and time the ticket was created (ISO 8601 format, e.g., ‘YYYY-MM-DDTHH:mm:ssZ’); HubSpot typically sets this automatically if not provided.
array
List of tag IDs associated with the ticket for categorization or filtering.
string
Date and time the ticket was closed (ISO 8601 format, e.g., ‘YYYY-MM-DDTHH:mm:ssZ’).
string
ID of the pipeline this ticket belongs to; often a required field.
string
Source channel through which the ticket was created; must be one of: ‘CHAT’, ‘EMAIL’, ‘FORM’, ‘PHONE’.
array
List defining associations between this new ticket and other existing HubSpot objects (e.g., linking to a contact or company). Each item specifies the target object ID (to) and the type of association (types).
string
Time taken to close the ticket, often in milliseconds or ISO 8601 duration (e.g. ‘PT2H30M’).
array
List of all team IDs associated with this ticket; usually managed by HubSpot.
string
ID of the HubSpot team this ticket is assigned to.
string
Date and time of the last reply (either from agent or contact) on this ticket (ISO 8601 format).
array
List of all HubSpot owner IDs associated with this ticket; usually managed by HubSpot.
string
Date and time of the last contact associated with this ticket (ISO 8601 format).
string
ID of the HubSpot user who owns this ticket.
object
Dictionary of custom properties for the ticket: keys are internal names (e.g., my_custom_field_name), values are the data.
string
ID of the current stage of the ticket within its pipeline; often required and must belong to the specified hs_pipeline.
string
ID of the primary company associated with this ticket.
string
Category of the ticket; must be one of: ‘PRODUCT_ISSUE’, ‘BILLING_ISSUE’, ‘FEATURE_REQUEST’, ‘GENERAL_INQUIRY’.
string
Priority of the ticket (e.g., ‘HIGH’, ‘MEDIUM’, ‘LOW’); values might be HubSpot-defined or custom.
string
Timestamp of when the notes for this ticket were last updated (ISO 8601 format).
string
Date and time this ticket was last modified (ISO 8601 format); HubSpot typically sets this automatically.
array
List of team IDs specifically assigned to this ticket.
string
Method used for assigning the ticket (e.g., ‘MANUAL’, ‘AUTOMATIC_ROUND_ROBIN’).
string
Date and time of the last engagement (e.g., email, call) with this ticket (ISO 8601 format).
string
Timestamp of the last contact logged in notes associated with the ticket (ISO 8601 format).
string
HubSpot user ID of the person or system that created this ticket.
string
Date and time of the first agent reply on this ticket (ISO 8601 format).
string
Timestamp for the next scheduled activity related to this ticket’s notes (ISO 8601 format).
array
List of all team IDs with access to this ticket; usually managed by HubSpot.
array
System-populated list of all mentions in conversations related to this ticket.
array
System-populated list of email addresses of contacts associated with this ticket.
array
System-populated list of phone numbers of contacts associated with this ticket.
string
If auto-generated from a conversation, the ID of the originating thread.
array
List of all business unit IDs assigned to this ticket; usually managed by HubSpot.
array
System-populated list of company names or IDs for contacts linked to this ticket.
array
System-populated list of last names of contacts associated with this ticket.
array
System-populated list of first names of contacts associated with this ticket.
array
System-populated list of mobile phone numbers of contacts associated with this ticket.
string
ID of the conversation thread from which this ticket originated.
string
ID of the first message in the conversation that led to this ticket’s creation.

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: HUBSPOT_CREATE_TICKETSCreates multiple HubSpot tickets in a batch, each with its own properties and associations; inputs list must not be empty, each item needs properties, and associations/custom properties must be validly defined using internal names for custom fields and ISO 8601 for dates.

Input Parameters

array
required
List of ticket creation requests; each item defines one ticket with its properties and associations.

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: HUBSPOT_CREATE_TIMELINE_EVENTCreates an immutable custom timeline event on a CRM object’s record using a specified, existing event template (identified by eventTemplateId), optionally updating CRM object properties if defined in the template; requires email, utk, or objectId for association.

Input Parameters

string
Optional unique event identifier; HubSpot auto-generates if omitted. Use {{uuid}} for uniqueness if providing an ID.
string
HubSpot user token (e.g., from hubspotutk cookie) to associate event with a contact; use if contact’s email is unknown.
string
Email for contact-specific events; identifies existing contact, creates new, or changes email (if objectId provided).
string
Domain associated with the event, often paired with utk for contact event context.
object
required
Key-value pairs for populating dynamic content in the event template; keys are token names from the template.
string
Unique identifier of the CRM object (e.g., company, deal) for event association; required for non-contact objects.
string
ISO 8601 UTC timestamp of event occurrence; defaults to current time. Determines timeline placement.
string
required
The unique identifier of the event template, which must exist in HubSpot.
string
URL of content to display in the iframe.
integer
Width of the iframe modal window (pixels).
integer
Height of the iframe modal window (pixels).
Text for the link that opens the iframe modal with more details.
string
Title/header for the modal window displaying iframe content.

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: HUBSPOT_CREATE_TIMELINE_EVENTS_BATCHCreates multiple immutable timeline events in a batch, ideal for bulk data imports or real-time synchronizations, using a valid event template; may update CRM properties if the template is so configured.

Input Parameters

array
required
A list of event objects to be created. Each object in the list must conform to the InputsRequest schema and define a single timeline event.

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: HUBSPOT_CREATE_WORKFLOWCreates a new HubSpot workflow to automate processes; ensure enrollmentCriteria and actions use properties relevant to the specified objectTypeId.

Input Parameters

string
required
The unique name for the workflow.
string ("CONTACT_FLOW" | "PLATFORM_FLOW")
‘CONTACT_FLOW’ for contact-based workflows, ‘PLATFORM_FLOW’ for workflows based on other CRM object types (deals, companies, tickets, custom objects).
array
required
Array of workflow action configurations. Each action must include: ‘actionId’ (unique string ID), ‘type’ (e.g., ‘SINGLE_CONNECTION’), ‘actionTypeId’ (e.g., ‘0-1’ for delay, ‘0-4’ for email), ‘actionTypeVersion’ (typically 0), ‘connection’ (object with ‘edgeType’ and ‘nextActionId’), and ‘fields’ (action-specific settings). Example: [{‘actionId’: ‘1’, ‘type’: ‘SINGLE_CONNECTION’, ‘actionTypeId’: ‘0-1’, ‘actionTypeVersion’: 0, ‘connection’: {‘edgeType’: ‘STANDARD’, ‘nextActionId’: ‘2’}, ‘fields’: {‘delayMillis’: 3600000}}]
string ("WORKFLOW" | "ACTION_SET" | "UNKNOWN")
Flow category: ‘WORKFLOW’ for standard workflows, ‘ACTION_SET’ for reusable action sets that can be called from other workflows.
boolean
Set to true to activate the workflow immediately upon creation, or false to create it in disabled state for review.
array
Data source configurations for conditions or personalization.
string
Optional explanation of the workflow’s purpose and functionality.
array
Configurations for periods when workflow actions can execute.
array
Configurations for dates when workflow actions should not execute.
string
HubSpot internal ID for the CRM object type: ‘0-1’ for Contacts, ‘0-2’ for Companies, ‘0-3’ for Deals, ‘0-5’ for Tickets, or custom object type ID.
string
required
The unique ID of the first action in the workflow. This must match the actionId of one of the actions in the actions array.
object
Custom key-value pairs for organization or tracking.
object
required
Required configuration defining enrollment triggers for the workflow. Must include: ‘type’ (either ‘EVENT_BASED’ or ‘LIST_BASED’), ‘shouldReEnroll’ (boolean for allowing re-enrollment), and either ‘eventFilterBranches’ (for event-based) or ‘listFilterBranch’ (for list-based enrollment). Example for event-based: {‘type’: ‘EVENT_BASED’, ‘shouldReEnroll’: false, ‘eventFilterBranches’: [{‘filterBranchType’: ‘OR’, ‘filterBranchOperator’: ‘OR’, ‘filters’: [{‘filterType’: ‘PROPERTY’, ‘property’: ‘email’, ‘operator’: ‘HAS_PROPERTY’}]}]}
array
HubSpot list IDs for contacts to be prevented from enrollment.
object
Defines if/how objects unenroll from other workflows upon enrolling in this one.
string
required
The next available action ID number for sequencing. This should be one higher than the highest action ID number used in the workflow.
boolean
Allow contacts to be enrolled directly from Salesforce.

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: HUBSPOT_DELETE_ASSOCIATION_LABELDelete one custom relationship-label definition between CRM object types.

Input Parameters

string
required
Destination CRM object type name or object type ID.
string
required
Source CRM object type name or object type ID.
integer
required
OpenAPI int32 ID of the custom association label to delete.

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: HUBSPOT_DELETE_CALLDeletes a HubSpot call record by its ID. The action returns error details in its response when the delete request fails.

Input Parameters

string
required
The unique identifier of the HubSpot call record to be deleted. This is a numeric ID that identifies the specific call engagement in the CRM.

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: HUBSPOT_DELETE_CALLING_EXTENSION_SETTINGSDeletes the settings for a calling extension app identified by its app ID. The action returns error details in its response when the delete request fails.

Input Parameters

integer
required
The unique identifier for the calling extension app to be deleted. This ID is assigned by HubSpot when the extension is created.

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: HUBSPOT_DELETE_CAMPAIGNPermanently deletes a marketing campaign from HubSpot using its campaignGuid; returns a 204 No Content status even if the campaign does not exist.

Input Parameters

string
required
The unique identifier (UUID) for the marketing campaign to be deleted.

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: HUBSPOT_DELETE_CAMPAIGNS_BATCHArchives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.

Input Parameters

array
required
A list of marketing campaign identifiers to be archived in batch.

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: HUBSPOT_DELETE_COMPANY_GDPRPermanently deletes a company (identified by objectId) and its associated data from HubSpot for GDPR compliance; this action is irreversible and requires the company to exist.

Input Parameters

string
required
The unique identifier of the company to be permanently deleted. If idProperty is specified, this is the value of that custom unique property. Otherwise, this is the company’s HubSpot Company ID.
string
Optional name of an alternate unique identifier property. If provided, objectId must be the value of this property for the company.

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: HUBSPOT_DELETE_CONTACT_GDPRIrreversibly erases a HubSpot contact and associated data per a GDPR request; if an email is given for a non-existent contact, it’s blocklisted.

Input Parameters

string
required
The contact’s identifier (email or HubSpot ID, based on idProperty) for permanent deletion.
string
Identifies how objectId should be interpreted: ‘email’ for email address, or null/omitted for HubSpot contact ID (default).

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: HUBSPOT_DELETE_CRM_LISTSoft-deletes a HubSpot CRM list by its ILS list ID.

Input Parameters

string
required
ILS ID of the CRM list to delete.

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: HUBSPOT_DELETE_DEAL_GDPRArchives a HubSpot deal by its ID. Note: HubSpot’s GDPR permanent deletion API only supports contacts, not deals. This action archives the deal (moves to recycling bin for 90 days) as the closest available functionality.

Input Parameters

string
required
The unique HubSpot Deal ID of the deal to archive. Archived deals are moved to the recycling bin and recoverable for 90 days.

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: HUBSPOT_DELETE_LINE_ITEMS_GDPRPermanently deletes a specified line item and its associated content for GDPR compliance; this action is irreversible and cannot be undone.

Input Parameters

string
required
The value of the unique identifier for the line item to be permanently deleted. This corresponds to the property named in idProperty, or the line item’s primary HubSpot ID if idProperty is not provided.
string
The name of the property that uniquely identifies the line item, if objectId is not its primary HubSpot ID. For example, ‘external_id’. If omitted, objectId is assumed to be the line item’s primary HubSpot ID.

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: HUBSPOT_DELETE_MARKETING_EMAILPermanently deletes a marketing email from your HubSpot account. This action cannot be undone.

Input Parameters

string
required
The unique identifier of the marketing email to delete.

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: HUBSPOT_DELETE_MEETINGPermanently deletes (archives) a HubSpot meeting by its ID, moving it to the recycling bin where it can be restored within 90 days. Use this action when you need to remove a meeting engagement from HubSpot’s CRM. This action is irreversible via the API — the meeting cannot be recovered programmatically once deleted.

Input Parameters

string
required
The unique HubSpot identifier for the meeting to be archived/deleted.

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: HUBSPOT_DELETE_NOTEArchives a HubSpot note by its ID, removing it from active view. The note is archived rather than permanently deleted and can be restored within 90 days. Use this action when you need to remove a note from the CRM without permanently deleting it. This action is irreversible through the API - archived notes cannot be restored programmatically.

Input Parameters

string
required
The unique numeric ID of the note to delete/archive. This is the HubSpot note record ID.

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: HUBSPOT_DELETE_PIPELINEPermanently deletes a HubSpot pipeline and all its stages by pipelineId and objectType; this is irreversible, so use validation flags to avoid errors if the pipeline is not empty.

Input Parameters

string
required
Type of CRM object associated with the pipeline, determining which pipeline category is affected.
string
required
Unique identifier of the pipeline to be deleted.
boolean
If true, HubSpot checks for existing references to this pipeline before deletion to prevent data loss or orphaned records.
boolean
If true (for deal pipelines), HubSpot verifies if any deals use stages from this pipeline before deletion to prevent disruption.

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: HUBSPOT_DELETE_PIPELINE_STAGEPermanently deletes a specific pipeline stage for an objectType (e.g., ‘deals’, ‘tickets’) that supports pipelines; this operation is irreversible, so ensure no active CRM records are associated with the stage to prevent data issues.

Input Parameters

string
required
Identifier of the pipeline stage to be deleted.
string
required
The CRM object type for the pipeline (e.g., ‘deals’, ‘tickets’).
string
required
Identifier of the pipeline (specific to the objectType) from which the stage will be deleted.

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: HUBSPOT_DELETE_SCHEMADeletes a HubSpot custom object schema by objectType. With archived=false (default), it archives the schema (soft delete). With archived=true, it permanently deletes an already-archived schema (hard delete). Prerequisites: All object instances, associations, and properties must be deleted first.

Input Parameters

boolean
Controls deletion type: false (default) archives the schema (soft delete), true permanently deletes an already-archived schema (hard delete). To fully remove a schema, first call with false to archive it, then call again with true to purge it.
string
required
The fully qualified name or object type ID of the custom object schema to delete. Must be an exact match to an existing schema. Note: All object instances, associations, and properties must be deleted before the schema can be removed.

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: HUBSPOT_DELETE_TASKArchives a HubSpot task by its ID, removing it from active task lists. Use this action when you need to delete or remove a task from HubSpot CRM. The task is archived rather than permanently deleted and may be recoverable. This action is irreversible from the API perspective — the task cannot be directly unarchived via this action.

Input Parameters

string
required
The unique identifier of the task to delete. Must be a numeric string (e.g., ‘12345678901’).

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: HUBSPOT_DELETE_TIMELINE_EVENT_TEMPLATEPermanently and irreversibly deletes a specific timeline event template, identified by its eventTemplateId, from the application appId.

Input Parameters

integer
required
The numeric identifier (positive integer) for the target application within which the event template exists. The template specified by eventTemplateId must be part of this application.
string
required
The unique identifier for the event template to be deleted. This ID must correspond to an existing template within the specified application. Typically a UUID or a system-generated string.

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: HUBSPOT_DELETE_VIDEO_CONFERENCING_APP_SETTINGSDeletes the settings for a specified HubSpot video conferencing application.

Input Parameters

integer
required
The unique identifier for the video conferencing application whose settings are to be deleted; assigned when the application is created in your HubSpot developer portal.

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: HUBSPOT_DELETE_WORKFLOWPermanently deletes a HubSpot workflow by its ID; deleted workflows cannot be restored via the API and the ID must exist. API error responses are returned in the result.

Input Parameters

string
required
The unique identifier of the HubSpot workflow to be deleted.

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: HUBSPOT_DOWNLOAD_CMS_SOURCE_FILEDownload one file from HubSpot’s CMS developer filesystem.

Input Parameters

string
required
Full file path in HubSpot’s CMS developer filesystem, including the file name.
string ("draft" | "published")
required
CMS source environment from which to download the file.

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: HUBSPOT_ENROLL_CONTACT_IN_WORKFLOWEnrolls a contact, identified by email, in a HubSpot workflow.

Input Parameters

string
required
The email address of the contact to enroll.
string
required
The positive numeric ID of the HubSpot contact workflow, passed as a string to preserve 64-bit values.

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: HUBSPOT_FETCH_IMPORT_ERROR_DETAILSFetches a paginated list of read-only error details for a specific HubSpot CRM import, requiring a valid importId for a processed import.

Input Parameters

string
Pagination token from a previous response’s paging.next.after property to fetch the next page of error details.
integer
Maximum number of error records to return per page (e.g., between 1 and a HubSpot-defined maximum of 100).
integer
required
Identifier of the import operation for which to fetch error details; must correspond to an existing import in HubSpot.

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: HUBSPOT_FETCH_RECORDING_SETTINGSFetches call recording settings for a specified, existing HubSpot calling extension app.

Input Parameters

integer
required
The unique identifier for an existing calling extension app.

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: HUBSPOT_FETCH_REVENUEFetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range; if both start and end dates are given, endDate must not be earlier than startDate.

Input Parameters

string
End date (YYYY-MM-DD) for filtering report data; defaults to the current date if omitted.
string
Start date (YYYY-MM-DD) for filtering report data; defaults to ‘2006-01-01’ if omitted.
string
required
The unique identifier (UUID) for the marketing campaign.
string
Attribution model for revenue calculation; defaults to ‘LINEAR’ if omitted. Allowed values: ‘LINEAR’, ‘FIRST_INTERACTION’, ‘LAST_INTERACTION’, ‘FULL_PATH’, ‘U_SHAPED’, ‘W_SHAPED’, ‘TIME_DECAY’, ‘J_SHAPED’, ‘INVERSE_J_SHAPED’.

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: HUBSPOT_GET_AB_EMAIL_VARIATIONRetrieves the alternate variation of a specified A/B marketing email; the emailId must identify an email currently in an A/B test. Requires Marketing Hub Professional or Enterprise subscription.

Input Parameters

string
required
The unique identifier of the A/B marketing email. If this ID refers to variation A, the details for variation B will be returned, and vice-versa.
boolean
Boolean variable to request archived email. Set to true to retrieve archived A/B test emails.
boolean
Boolean variable to request stats to be returned in response. Set to true to include email performance statistics.
boolean
Boolean variable to request name of the associated workflows in response. Set to true to include workflow names.
array
List of properties to be returned in the API response. If not specified, all properties will be returned.
boolean
Boolean variable to request name of the campaign in response. Set to true to include associated campaign names.

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: HUBSPOT_GET_ACCOUNT_INFORetrieves current HubSpot account details, including the account ID, time zone, currencies, UI domain and data hosting location.

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: HUBSPOT_GET_ACTIVE_IMPORTS_LISTRetrieves a list of currently active import jobs in HubSpot for monitoring ongoing data operations.

Input Parameters

string
Cursor for the next page of results, from a previous response’s paging.next.after property.
integer
Maximum number of import results per page.
string
Cursor for the previous page of results, obtained from a previous 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: HUBSPOT_GET_AGGREGATED_STATISTIC_INTERVALSRetrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.

Input Parameters

array
Optional list of specific email IDs to filter results; if omitted, statistics for all emails in the time range are returned.
string ("YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "QUARTER_HOUR" | "MINUTE" | "SECOND")
Time interval for aggregating email statistics, defining data granularity (e.g., YEAR, MONTH, DAY).
string
End of the time span for statistics (ISO8601 timestamp); must be on or after startTimestamp.
string
Start of the time span for statistics (ISO8601 timestamp).

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: HUBSPOT_GET_AGGREGATED_STATISTICSRetrieves aggregated marketing email statistics for a time range, with optional email ID and property parameters. Missing start and end timestamps default to 30 days ago and the current time, respectively.

Input Parameters

array
Filter statistics by specific email IDs.
string
Specific email property to include (e.g., ‘subject’, ‘campaignGuid’); if omitted, all available properties are returned. See HubSpot docs for available properties.
string
End of the time range (ISO8601 format); statistics are aggregated for emails sent on or before this time. Required by the API; if not provided, defaults to current time.
string
Start of the time range (ISO8601 format); statistics are aggregated for emails sent on or after this time. Required by the API; if not provided, defaults to 30 days ago.

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: HUBSPOT_GET_ALL_MARKETING_EMAILS_FOR_A_HUBSPOT_ACCOUNTFetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics.

Input Parameters

array
A list of fields to sort the results by. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. Prefix with ’-’ for descending order (e.g., ‘-createdAt’). createdAt is the default sort order if unspecified.
string ("AB_EMAIL" | "BATCH_EMAIL" | "LOCALTIME_EMAIL" | "AUTOMATED_AB_EMAIL" | "BLOG_EMAIL" | "BLOG_EMAIL_CHILD" | "RSS_EMAIL" | "RSS_EMAIL_CHILD" | "RESUBSCRIBE_EMAIL" | "OPTIN_EMAIL" | "OPTIN_FOLLOWUP_EMAIL" | "AUTOMATED_EMAIL" | "FEEDBACK_CES_EMAIL" | "FEEDBACK_CUSTOM_EMAIL" | "FEEDBACK_CUSTOM_SURVEY_EMAIL" | "FEEDBACK_NPS_EMAIL" | "FOLLOWUP_EMAIL" | "LEADFLOW_EMAIL" | "SINGLE_SEND_API" | "MARKETING_SINGLE_SEND_API" | "SMTP_TOKEN" | "TICKET_EMAIL" | "MEMBERSHIP_REGISTRATION_EMAIL" | "MEMBERSHIP_PASSWORD_SAVED_EMAIL" | "MEMBERSHIP_PASSWORD_RESET_EMAIL" | "MEMBERSHIP_EMAIL_VERIFICATION_EMAIL" | "MEMBERSHIP_OTP_LOGIN_EMAIL")
Filter emails by type. Multiple types can be specified. If omitted, emails of all types are returned. See TypeEnm for allowed values.
string
The cursor token to retrieve the next page of results. This value is obtained from the paging.next.after property of a previous paged response.
integer
The maximum number of emails to return per page. Default is 100, max is 100.
boolean
Specifies whether to include archived emails in the results. Defaults to false (archived emails are not returned). Set to true to retrieve archived emails.
string
Filter emails created at this exact ISO 8601 date-time (e.g., ‘2023-10-26T10:30:00Z’).
string
Filter emails last updated at this exact ISO 8601 date-time (e.g., ‘2023-10-26T12:45:00Z’).
boolean
Filter emails based on their publication status: true for published emails, false for draft emails. If omitted, both published and draft emails are returned.
string
Filter emails created after this ISO 8601 date-time (e.g., ‘2023-10-26T00:00:00Z’).
boolean
If true, includes statistics (e.g., open rates, click rates) with each email. Defaults to false.
string
Filter emails last updated after this ISO 8601 date-time (e.g., ‘2023-10-26T00:00:00Z’).
string
Filter emails created before this ISO 8601 date-time (e.g., ‘2023-10-27T00:00:00Z’).
string
Filter emails last updated before this ISO 8601 date-time (e.g., ‘2023-10-27T00:00:00Z’).
array
A list of specific property names to include in the response for each email object. If omitted, a default set of properties is returned. Consult the HubSpot API documentation for available email properties.

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: HUBSPOT_GET_BLOG_POSTRetrieves one HubSpot CMS blog post by post ID.

Input Parameters

string
required
Unique HubSpot ID of the blog post to retrieve.
boolean
Whether to retrieve the archived version of the blog post.
string
A blog post property to include 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: HUBSPOT_GET_BLOG_TAGRetrieves one HubSpot CMS blog tag by tag ID.

Input Parameters

string
required
Unique HubSpot blog tag ID.
boolean
Whether to retrieve the archived version of the blog tag.
string
A blog tag property to include 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: HUBSPOT_GET_CAMPAIGNRetrieves a HubSpot campaign by its ID.

Input Parameters

string
required
Unique HubSpot identifier for the campaign to retrieve.

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: HUBSPOT_GET_CAMPAIGN_METRICSRetrieves key attribution metrics for an existing marketing campaign, identified by its campaignGuid, within an optional date range.

Input Parameters

string
The end date (YYYY-MM-DD) for filtering report data. Defaults to the current date if not specified.
string
The start date (YYYY-MM-DD) for filtering report data. Defaults to 2006-01-01 if not specified.
string
required
The unique identifier (UUID) for the marketing campaign for which to retrieve metrics.

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: HUBSPOT_GET_CAMPAIGNSRetrieves multiple HubSpot campaigns.

Input Parameters

string
Pagination token from previous response.
integer
Maximum number of campaigns to return.

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: HUBSPOT_GET_CMS_SOURCE_METADATARetrieves metadata for one HubSpot CMS source path.

Input Parameters

string
required
Full file or folder path in the CMS developer file system, without a leading slash.
string
Comma-separated metadata properties to include in the response.
string ("draft" | "published")
required
CMS source environment: draft for unpublished changes or published for live content.

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: HUBSPOT_GET_COMMUNICATION_STATUSRetrieves detailed HubSpot communication statuses for an email address.

Input Parameters

string
required
Email address whose communication statuses to retrieve.

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: HUBSPOT_GET_COMPANYRetrieves a HubSpot company by its ID.

Input Parameters

boolean
Set to true to include only archived companies; defaults to false (active companies).
string
required
Unique HubSpot identifier for the company to retrieve.
array
Company property names to include in the response; if omitted, only default properties (name, domain, createdate, etc.) are returned. Use “all” to retrieve all properties, or specify individual property names. Accepts a list of strings or a JSON-stringified array (e.g., ’[“name”, “domain”]’).
array
Object types (e.g., ‘contacts’, ‘deals’) to include associated object IDs in the response. Accepts a list of strings or a JSON-stringified array (e.g., ’[“contacts”, “deals”]’).
array
Property names for which to include current and historical values in the response. Accepts a list of strings or a JSON-stringified array.

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: HUBSPOT_GET_CONTACT_IDSFetches a list of contact IDs for a specific HubSpot campaign based on interaction type.

Input Parameters

string
A pagination cursor. Used to fetch the next set of results. Provide the ‘after’ value from a previous response to get subsequent pages. Example: NTI1Cg%3D%3D
integer
The maximum number of contact IDs to return in a single request. Default is 100.
string
The end date for filtering report data, formatted as YYYY-MM-DD. If not provided, defaults to the current date.
string
The start date for filtering report data, formatted as YYYY-MM-DD. If not provided, defaults to 2006-01-01.
string
required
The type of contact interaction to filter by. Allowed values: ‘contactFirstTouch’ (contacts whose first interaction was with this campaign), ‘contactLastTouch’ (contacts whose last interaction before a key event was with this campaign), ‘influencedContacts’ (all contacts who interacted with assets of this campaign).
string
required
The unique identifier (UUID) of the campaign for which to fetch contact IDs.

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: HUBSPOT_GET_CONTACT_WORKFLOW_ENROLLMENTSReturn the workflows in which a HubSpot contact is currently enrolled.

Input Parameters

string
required
The positive numeric HubSpot contact ID, passed as a string to preserve 64-bit values.

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: HUBSPOT_GET_CRM_EXPORT_STATUSRetrieves the status and available result of a HubSpot CRM export task.

Input Parameters

integer
required
Numeric task ID returned when the CRM export was started.

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: HUBSPOT_GET_CRM_LISTRetrieves a HubSpot CRM list by its ILS list ID.

Input Parameters

string
required
ILS ID of the CRM list to retrieve.
boolean
Whether to include the list’s complete filter branch 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: HUBSPOT_GET_CRM_LIST_BY_NAMERetrieves a HubSpot CRM list by object type and exact name.

Input Parameters

string
required
Exact CRM list name. HubSpot matches this value case-insensitively.
string
required
HubSpot object type ID of the records in the list.
boolean
Whether to include the list’s complete filter branch 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: HUBSPOT_GET_CRM_LISTS_BY_IDSRetrieves multiple HubSpot CRM lists by their current IDs.

Input Parameters

array
required
Current CRM list IDs to retrieve. Each ID is sent as a repeated listIds query value.
boolean
Whether to include each list’s complete filter branch 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: HUBSPOT_GET_DEALRetrieves a HubSpot deal by its ID.

Input Parameters

string
required
Unique HubSpot identifier for the deal to retrieve.
boolean
Set to true to include only archived deals; defaults to false (active deals).
array
Deal property names to include in the response; if omitted, all available properties are returned.
array
Object types (e.g., ‘contacts’, ‘companies’) for which to retrieve associated IDs.
array
Property names for which to include current and historical values 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: HUBSPOT_GET_DEALSRetrieves multiple HubSpot deals by their IDs in a single batch request.

Input Parameters

array
required
List of deal identifiers to retrieve.
boolean
Filter by archived status.
string
Alternate unique identifier property to use for retrieving deals.
array
Deal property names to include in the response. If not specified, only default properties will be returned. Common properties include: dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id.
array
Deal property names for which to retrieve historical values. Leave empty if historical data is not needed.

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: HUBSPOT_GET_EMAILSRetrieves multiple HubSpot email engagement records by their IDs in a single batch request.

Input Parameters

array
required
List of email identifiers to retrieve.
boolean
Filter by archived status.
string
Alternate unique identifier property to use.
array
required
Email property names to include in the response.
array
Email property names for which to retrieve historical values. Leave empty if history is not needed.

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: HUBSPOT_GET_EMAIL_SUBSCRIPTION_STATUSRetrieves legacy overall email delivery and subscription state for an address.

Input Parameters

string
required
Email address whose subscription status to retrieve.

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: HUBSPOT_GET_ENGAGEMENTRetrieve one legacy aggregate engagement by its engagement ID.

Input Parameters

string
required
The unique legacy aggregate engagement ID to retrieve.

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: HUBSPOT_GET_EVENT_TEMPLATERetrieves detailed information about a specific event template for a given application in HubSpot’s CRM timeline.

Input Parameters

integer
required
The ID of the target application for which the event template is being retrieved. This parameter is required and ensures the template lookup is specific to an app integration within HubSpot. The appId must be a valid, existing app ID in your HubSpot account.
string
required
The unique identifier of the event template. This ID is assigned by HubSpot when the template is created. It is required and must be a valid, existing template ID associated with the specified app.

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: HUBSPOT_GET_EXCHANGE_RATERetrieves one HubSpot account exchange rate by ID.

Input Parameters

string
required
Unique HubSpot exchange rate ID.

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: HUBSPOT_GET_FILERetrieves one HubSpot file-manager record by file ID.

Input Parameters

string
required
Numeric HubSpot file ID to retrieve.
array
File properties to include. HubSpot sends each value as a repeated properties query parameter.

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: HUBSPOT_GET_FILE_IMPORT_STATUSRetrieves the status and result of a HubSpot URL file import task.

Input Parameters

string
required
Task ID returned when the URL file import was started.

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: HUBSPOT_GET_FILE_SIGNED_URLGenerates a temporary signed URL for one HubSpot file.

Input Parameters

string ("icon" | "medium" | "preview" | "thumb")
Image rendition to serve without changing the original file.
string
required
Positive numeric HubSpot file ID.
boolean
Whether to upscale an image to the requested rendition size.
integer
How long the temporary URL remains valid, in seconds.

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: HUBSPOT_GET_FORMRetrieves one HubSpot marketing form definition by form ID.

Input Parameters

string
required
Unique HubSpot form ID.
boolean
Whether to retrieve an archived form.

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: HUBSPOT_GET_IMPORT_RECORD_INFORMATIONRetrieves a HubSpot CRM import record by ID, including its status, metadata, and import configuration when available.

Input Parameters

integer
required
The unique identifier for the import record to retrieve, typically obtained when an import is initiated or from a list of imports.

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: HUBSPOT_GET_LANDING_PAGERetrieve one HubSpot CMS landing page by page ID.

Input Parameters

string
required
Unique HubSpot ID of the landing page to retrieve.
boolean
Whether to return the landing page even if it has been deleted (archived). Defaults to HubSpot’s behavior of excluding deleted pages.
string
A landing-page property to include 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: HUBSPOT_GET_LANDING_PAGE_DRAFTRetrieve the full editable draft of one HubSpot landing page.

Input Parameters

string
required
Unique HubSpot ID of the landing page whose draft to retrieve.

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: HUBSPOT_GET_MARKETING_EMAIL_DRAFTRetrieves the draft version of a marketing email by its emailId; if no draft exists, returns the published version.

Input Parameters

string
required
The unique identifier of the marketing email. Used to fetch its draft version or, if unavailable, its published version.

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: HUBSPOT_GET_MARKETING_EMAIL_REVISIONRetrieves a specific, previously saved revision of a marketing email using its unique email ID and revision ID.

Input Parameters

string
required
The unique identifier of the marketing email whose revision is to be fetched.
string
required
The unique identifier of the specific revision of the marketing email to be retrieved.

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: HUBSPOT_GET_MARKETING_EMAIL_REVISIONSRetrieves a paginated list of all historical versions (including full state like content, settings, metadata) for a specified, existing marketing email; revision ID -1 identifies the current version.

Input Parameters

string
Cursor for the next page of results, typically from paging.next.after in a previous response.
integer
Maximum number of email revisions per page. The API defaults to 100 if this parameter is not provided.
string
Cursor for the previous page of results, typically from paging.prev.before in a previous response.
string
required
The unique identifier of the marketing email for which revisions are to be fetched.

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: HUBSPOT_GET_MARKETING_EVENT_PARTICIPATION_BREAKDOWNPages participation records for one HubSpot marketing event.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of participation records to return, from 1 to 100. HubSpot defaults to 10.
string ("REGISTERED" | "CANCELLED" | "ATTENDED" | "NO_SHOW")
Participation state used to filter the event’s records.
string
Email address or HubSpot record ID of a contact to filter by.
string
required
Numeric HubSpot record ID represented as a string to preserve 64-bit precision.

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: HUBSPOT_GET_PIPELINE_BY_IDRetrieves a specific pipeline by its ID and CRM object type, detailing its stages and properties.

Input Parameters

string
required
The CRM object type for which the pipeline is being retrieved. Must be a valid HubSpot object type that supports pipelines.
string
required
Unique identifier of the pipeline to retrieve for the specified object type, typically a system-generated string or UUID.

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: HUBSPOT_GET_PIPELINE_STAGE_AUDITRetrieves a reverse chronological list of all mutations (changes) for a specific pipeline stage, including CREATE and UPDATE events with timestamps and details.

Input Parameters

string
required
The unique identifier of the pipeline stage.
string
required
The CRM object type (e.g., ‘deals’, ‘tickets’) for the pipeline stage.
string
required
The unique identifier of the pipeline containing the stage.

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: HUBSPOT_GET_PRIVATE_APP_DAILY_API_USAGERetrieve daily private-app API consumption and limits.

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: HUBSPOT_GET_PRODUCTRetrieves a HubSpot product by its ID.

Input Parameters

boolean
Filter by archived status.
string
required
Unique HubSpot identifier for the product to retrieve.
array
Product property names to include in the response.
array
Object types for which to retrieve associated IDs.
array
Property names for which to include historical values.

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: HUBSPOT_GET_PRODUCTSRetrieves multiple HubSpot products in a batch by their IDs or by values of a specified alternate unique identifier property.

Input Parameters

array
required
List of product identifiers to retrieve.
boolean
Whether to include archived products in the results. Set to true to retrieve only archived products, false (default) to retrieve only active products.
string
Alternate unique identifier property to use.
array
required
Product property names to include in the response. Common properties include: name, price, description, hs_sku, hs_cost_of_goods_sold, hs_bundle_type, hs_pricing_model, hs_recurring_billing_period, hs_product_classification.
array
Product property names for which to retrieve historical values. Pass an empty array if historical data is not needed.

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: HUBSPOT_GET_QUOTERetrieves a specific HubSpot quote by its unique identifier.

Input Parameters

string
required
Unique identifier of the quote; can be the HubSpot object ID or a custom unique property value if idProperty is specified.
boolean
Specifies whether the quote to retrieve is archived (True) or active (False).
string
Internal name of a unique custom property to use as the quote identifier instead of the HubSpot object ID; this property must have unique values across all quotes.
array
HubSpot property internal names to include in the response; limits data returned and improves performance. Non-existent properties are ignored.
array
Object type names (e.g., ‘deals’, ‘contacts’) for which to retrieve IDs of associated objects; fetches linked CRM object IDs. Non-existent association types are ignored.
array
HubSpot property internal names for which to include historical values; retrieves change history. Non-existent properties or those without history are ignored.

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: HUBSPOT_GET_RECORD_LIST_MEMBERSHIPSReturn the HubSpot lists that contain one CRM record.

Input Parameters

string
required
CRM record ID whose list memberships should be returned.
string
required
HubSpot object type ID for the record, such as 0-1 for contacts.

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: HUBSPOT_GET_SEGMENT_MEMBERSTool to retrieve segment (list) members ordered by join timestamp. Use when you need to page through list membership data.

Input Parameters

string
Cursor token to fetch records after the last returned record; sorts ascending. Overrides before if both provided.
integer
Number of records to return; default 100; maximum 250.
string
Cursor token to fetch records before the previously returned records; sorts descending.
string
required
The ID of the list (segment) to retrieve members for.

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: HUBSPOT_GET_SETTINGS_USERRetrieves one HubSpot settings user by user ID or email.

Input Parameters

string
required
HubSpot user ID, or the user’s email when id_property is EMAIL.
string ("EMAIL" | "USER_ID")
Properties HubSpot accepts for identifying a settings user.

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: HUBSPOT_GET_SITE_PAGERetrieve one HubSpot site page by ID.

Input Parameters

string
required
Unique HubSpot ID of the site page to retrieve.
boolean
Whether to retrieve a deleted site page. Defaults to false; this does not select a draft or revision.
string
Optional site-page property selector accepted by HubSpot.

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: HUBSPOT_GET_SITE_PAGE_DRAFTRetrieve the full editable draft of one HubSpot site page.

Input Parameters

string
required
Unique HubSpot ID of the site page whose draft to retrieve.

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: HUBSPOT_GET_THE_DETAILS_OF_A_SPECIFIED_MARKETING_EMAILRetrieves detailed information for a specific marketing email in HubSpot using its unique email ID, optionally including performance statistics and specific properties.

Input Parameters

string
required
The unique identifier of the marketing email to retrieve.
boolean
Filter by archived status: true for archived, false for not archived. Omit to retrieve regardless of archived status.
boolean
Whether to include performance statistics (e.g., open rates, click-through rates) with the email details.
array
Specific marketing email property names to include in the response (e.g., “name”, “subject”, “createdById”). If omitted, a default set of properties is returned.

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: HUBSPOT_GET_TICKETRetrieves a HubSpot ticket by its ID.

Input Parameters

boolean
Filter by archived status.
string
required
Unique HubSpot identifier for the ticket to retrieve.
array
Ticket property names to include in the response.
array
Object types for which to retrieve associated IDs.
array
Property names for which to include historical values.

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: HUBSPOT_GET_TICKETSRetrieves multiple HubSpot tickets in a batch by ticket IDs or values of an alternate unique identifier property.

Input Parameters

array
required
List of ticket identifiers to retrieve.
boolean
Filter by archived status.
string
Alternate unique identifier property to use.
array
required
Ticket property names to include in the response. Common properties: subject, content, hs_ticket_priority, hs_ticket_category, hs_pipeline_stage, createdate, hubspot_owner_id.
array
Ticket property names for which to retrieve historical values. Leave empty if you only need current values.

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: HUBSPOT_GET_WORKFLOW_BY_IDRetrieves a HubSpot workflow by ID. Uses v4 normally and recovers legacy workflows through v3 only for the known v4 HTML 404 or number-comparative conversion failure; legacy details retain their v3 field names.

Input Parameters

string
required
The unique identifier of the HubSpot workflow to retrieve. This ID can be found by using the ‘Get all workflows’ action or from the URL when viewing a workflow in the HubSpot UI.

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: HUBSPOT_GET_WORKFLOW_PERFORMANCEReturn enrolled, completed, and unenrolled workflow counts by time bucket.

Input Parameters

integer
required
Inclusive end of the reporting interval as Unix epoch milliseconds.
integer
required
Inclusive start of the reporting interval as Unix epoch milliseconds.
string ("DAY" | "WEEK" | "MONTH")
required
Granularity used to bucket workflow metrics.
string
required
Unique ID of the HubSpot workflow to measure.

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: HUBSPOT_GET_WORKFLOW_REVISIONRetrieves a specific historical revision of a HubSpot workflow.

Input Parameters

string
required
Unique ID of the HubSpot workflow whose revision to retrieve.
string
required
Unique ID of the historical workflow revision to retrieve.

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: HUBSPOT_GET_WORKFLOWSRetrieves workflow summaries from HubSpot in a single request, applying the limit locally to the returned list.

Input Parameters

integer
Maximum number of workflows to retrieve per API call, used for pagination.

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: HUBSPOT_LIST_ALL_ENGAGEMENTSLists one page from HubSpot’s complete legacy aggregate engagement feed.

Input Parameters

integer
Maximum number of engagements to return, from 1 to 250.
integer
Numeric offset returned by a previous response. Omit for the first page.

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: HUBSPOT_LIST_ASSETSLists assets of a specified type associated with a HubSpot marketing campaign, with pagination and optional date-range parameters. Responses are validated against a file-asset schema and do not expose performance metrics.

Input Parameters

string
Pagination cursor from ‘paging.next.after’ of a previous response; results will begin after this cursor.
string
Maximum number of assets to return per response (positive integer).
string
End date (YYYY-MM-DD, inclusive) for asset performance metrics. Metrics are not fetched if startDate or endDate is missing/invalid.
string
required
The specific type of asset to retrieve (e.g., BLOG_POST, LANDING_PAGE); only one asset type per request.
string
Start date (YYYY-MM-DD, inclusive) for asset performance metrics. Metrics are not fetched if startDate or endDate is missing/invalid.
string
required
Unique identifier (UUID) of an existing marketing campaign whose assets are to be listed.

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: HUBSPOT_LIST_ASSOCIATED_ENGAGEMENTSLists one page of legacy engagements associated with a contact or company.

Input Parameters

integer
Maximum number of engagements to return, from 1 to 250.
integer
Numeric offset returned by a previous response. Omit for the first page.
string
required
Positive numeric HubSpot ID of the contact or company.
string ("CONTACT" | "COMPANY")
required
CRM record type whose mixed engagements to retrieve.

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: HUBSPOT_LIST_ASSOCIATION_LABELSReturn v4 association labels for a directed pair of CRM object types.

Input Parameters

string
required
Target CRM object type, such as contacts, companies, deals, or tickets.
string
required
Source CRM object type, such as contacts, companies, deals, or tickets.

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: HUBSPOT_LIST_ASSOCIATION_TYPESLists all valid association types between two specified HubSpot CRM object types.

Input Parameters

string
required
The type of the second object in the association (e.g., contact, company, deal).
string
required
The type of the first object in the association (e.g., contact, company, deal).

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: HUBSPOT_LIST_AUDIT_LOGSLists Enterprise-only HubSpot account audit logs with optional filters and pagination.

Input Parameters

array
HubSpot sort expressions, sent as repeated sort query parameters.
string
Paging cursor from a previous response’s paging.next.after field.
integer
Maximum number of audit log entries to return per page.
array
User IDs whose actions should be returned. Each ID is sent as a repeated actingUserId query parameter.
string
Return actions that occurred after this RFC3339 timestamp.
string
Return actions that occurred before this RFC3339 timestamp.
boolean
Value for HubSpot’s fillFinalTimestamp query parameter. HubSpot does not document its behavior.

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: HUBSPOT_LIST_AUTOMATION_FLOWSLists HubSpot v4 automation flows with forward pagination.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of automation flows to return on this page.

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: HUBSPOT_LIST_BLOG_POSTSLists HubSpot CMS blog posts with documented filters and cursor pagination.

Input Parameters

array
Sort by createdAt, name, updatedAt, createdBy, or updatedBy; prefix a field with - for descending order.
string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of blog posts to return. HubSpot defaults to 20.
boolean
Return deleted blog posts instead of active blog posts.
string
Specific blog post property to include in the response.
string
Return blog posts created at this exact ISO 8601 date-time.
string
Return blog posts updated at this exact ISO 8601 date-time.
string
Return blog posts created after this ISO 8601 date-time.
string
Return blog posts updated after this ISO 8601 date-time.
string
Return blog posts created before this ISO 8601 date-time.
string
Return blog posts updated before this ISO 8601 date-time.

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: HUBSPOT_LIST_CALL_DISPOSITIONSReturn HubSpot call disposition IDs and labels.

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: HUBSPOT_LIST_COMPANIESRetrieves a paginated list of HubSpot companies.

Input Parameters

string
Pagination token from paging.next.after of a previous response, used to fetch the subsequent page. Omit for the first page.
integer
Maximum number of companies to return per page, controlling pagination size (default: 10).
boolean
Boolean flag to filter companies by archived status: true returns only archived companies; false (default) returns only active companies.
array
List of company property internal names to include in the response (e.g., ‘name’, ‘domain’). If omitted, a default set of properties is returned.
array
List of object types (e.g., ‘contacts’, ‘deals’) for which to retrieve associated IDs with each company.
array
List of property internal names for which to retrieve historical values (e.g., ‘industry’). If no history exists for a property, only its current value is returned.

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: HUBSPOT_LIST_COMPANY_ACTIVITIESLists a page of activity associations for a HubSpot company and a specified activity type, such as calls, emails, meetings, notes, or tasks. Returns associated record IDs and association metadata, with a cursor for further pages when available.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of activity associations to return per page. Default is 25.
string
required
The unique ID of the company whose activities you want to retrieve.
string
required
Type of activity/engagement to retrieve (e.g., ‘calls’, ‘emails’, ‘meetings’, ‘notes’, ‘tasks’). Specify the plural form of the engagement object type.

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: HUBSPOT_LIST_COMPANY_CALLSLists a page of call associations for a HubSpot company, returning call IDs and association types. A cursor can be used to retrieve further pages.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of call associations to return per page. Default is 25.
string
required
The unique ID of the company whose associated calls you want to retrieve.

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: HUBSPOT_LIST_COMPANY_MEETINGSLists a page of meetings associated with a HubSpot company, returning meeting IDs and association metadata. A cursor can be used to retrieve further pages.

Input Parameters

string
Pagination cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of meeting associations to return per page. Default is 25.
string
required
The unique ID of the company record whose associated meetings you want to retrieve.

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: HUBSPOT_LIST_CONTACT_NOTESLists a page of notes associated with a HubSpot contact, returning note IDs and association metadata. A cursor can be used to retrieve further pages.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of note associations to return per page. Default is 25, maximum is 500.
string
required
The unique ID of the contact whose notes you want to retrieve.

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: HUBSPOT_LIST_CONTACT_PROPERTIESLists all contact properties in your HubSpot account, including custom properties you’ve created. Use this action to discover: - Available property names for updating contacts - Custom properties specific to your HubSpot account - Property types and valid options for enumeration fields - Which properties are read-only vs writable

Input Parameters

boolean
Whether to include archived properties. Set to true to see archived properties, false for active only.
boolean
Filter to only return custom properties (excludes HubSpot default properties). Custom properties are ones you created in your HubSpot account.

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: HUBSPOT_LIST_CONTACTSRetrieves a paginated list of HubSpot contacts.

Input Parameters

string
Pagination token from paging.next.after of a previous response, used to fetch the subsequent page. Omit for the first page. Empty strings will be treated as None.
integer
Maximum number of contacts to return per page, controlling pagination size (default: 10).
boolean
Boolean flag to filter contacts by archived status: true returns only archived contacts; false (default) returns only active (non-archived) contacts.
array
List of contact property internal names to include in the response (e.g., “email”, “firstname”). If omitted, a default set of properties is returned.
array
List of object types (e.g., “companies”, “deals”) for which to retrieve associated IDs with each contact.
array
List of property internal names for which to retrieve historical values (e.g., “lifecyclestage”). If no history exists for a property, only its current value is returned.

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: HUBSPOT_LIST_CONTACT_TASKSLists a page of tasks associated with a HubSpot contact, returning task IDs and association metadata. A cursor can be used to retrieve further pages.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of task associations to return per page. Default is 25.
string
required
The unique ID of the contact whose associated tasks you want to retrieve.

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: HUBSPOT_LIST_CONTENT_TEMPLATESReturns one offset-controlled page of HubSpot content templates.

Input Parameters

string
Filter templates by their Design Manager path.
string
Filter templates by their human-readable label.
integer
Maximum number of content templates to return on this page.
integer
Numeric offset from the previous response; omit for the first page.
integer
Filter by the template deletion time as a Unix timestamp in milliseconds.
string
Filter for one template using its numeric HubSpot template ID.
boolean
Filter by whether templates can be selected for newly created content.

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: HUBSPOT_LIST_CONVERSATION_CHANNELSLists HubSpot conversation channels with sorting and pagination.

Input Parameters

array
Sort expressions to apply in order.
string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of conversation channels to return on this page.
integer
Default number of conversation channels to return on this page.

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: HUBSPOT_LIST_CONVERSATION_INBOXESLists HubSpot conversation inbox resources with cursor pagination.

Input Parameters

array
Sort expressions to apply in order; prefix a field with - for descending order.
string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of conversation inboxes to return on this page.
boolean
Whether to return archived conversation inboxes.
integer
Default number of inboxes to return when HubSpot applies pagination.

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: HUBSPOT_LIST_CONVERSATION_THREADSLists HubSpot conversation threads with filtering and forward pagination.

Input Parameters

array
Sort expressions to apply in order; prefix a field with - for descending order.
string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of conversation threads to return on this page.
array
Return threads from any of these conversations inbox IDs, represented as strings to preserve 64-bit values.
boolean
Whether to return only archived conversation threads.
string
Conversation thread property to include in the response.
array
Association types to include. HubSpot currently supports TICKET.
string ("CLOSED" | "OPEN")
Return only conversation threads with this status.
string
Return threads associated with this HubSpot ticket ID, represented as a string to preserve 64-bit values.
string
Return threads associated with this HubSpot contact ID, represented as a string to preserve 64-bit values.
string
Return threads whose latest message is after this ISO 8601 timestamp.

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: HUBSPOT_LIST_DEAL_ACTIVITIESRetrieves the first page of note, call, email, meeting, and task associations for a HubSpot deal, including activity IDs and association metadata. The returned count covers the retrieved associations, not necessarily all activities.

Input Parameters

integer
Maximum number of activities to return. Default is 25.
string
required
Unique HubSpot identifier for the deal whose activities you want to retrieve.

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: HUBSPOT_LIST_DEAL_MEETINGSLists a page of meetings associated with a HubSpot deal, returning meeting IDs and association metadata. Use the returned cursor to request another page.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of meeting associations to return per page. Default is 25.
string
required
The unique ID of the deal whose associated meetings you want to retrieve.

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: HUBSPOT_LIST_DEALSRetrieves a paginated list of HubSpot deals.

Input Parameters

string
Pagination token from previous response to fetch the subsequent page.
integer
Maximum number of deals to return per page (default: 10). Maximum is 100 normally, but when propertiesWithHistory is requested, the maximum is 50.
boolean
Filter by archived status: true for archived deals, false for active deals.
array
List of deal property names to include in the response.
array
List of object types for which to retrieve associated IDs.
array
List of property names for which to retrieve historical values.

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: HUBSPOT_LIST_DOMAINSReturn one cursor-controlled page of connected HubSpot CMS domains.

Input Parameters

array
Sort expressions to apply in order; prefix a field with - for descending order.
string
Cursor from paging.next.after in the previous response; omit for the first page.
integer
Maximum number of domains to return on this page.
boolean
Return archived domains instead of active domains.
string
Return domains created at this exact ISO 8601 date-time.
string
Return domains updated at this exact ISO 8601 date-time.
string
Return domains created after this ISO 8601 date-time.
string
Return domains updated after this ISO 8601 date-time.
string
Return domains created before this ISO 8601 date-time.
string
Return domains updated before this ISO 8601 date-time.

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: HUBSPOT_LIST_EMAIL_CAMPAIGN_IDSLists one paginated page of HubSpot email campaign IDs.

Input Parameters

integer
Maximum number of campaign IDs to return on this page.
string
Opaque pagination token returned as offset by a previous response; use it only when that response has hasMore set to true.

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: HUBSPOT_LIST_EMAIL_CAMPAIGNSLists email-analytics campaign IDs ordered by recent activity.

Input Parameters

integer
Maximum number of campaign IDs to return on this page.
string
Opaque pagination token returned as offset by a previous response; use it only when that response has hasMore set to true.

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: HUBSPOT_LIST_EMAIL_EVENTSLists one page of HubSpot marketing email events; continue with offset only while hasMore is true.

Input Parameters

string
Return only events generated by this HubSpot application ID.
integer
Maximum number of email events to return, from 1 through 1000.
string
Opaque pagination token returned as offset by a previous response; use it only when that response has hasMore set to true.
string
Case-sensitive email event type to return, such as SENT, DELIVERED, OPEN, CLICK, or BOUNCE.
string
Return only events for this recipient email address.
string
Return only events for this HubSpot email campaign ID.
integer
Return events created at or before this Unix epoch timestamp in milliseconds.
integer
Return events created at or after this Unix epoch timestamp in milliseconds.
boolean
Whether to omit events excluded by the account’s customer filtering settings.

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: HUBSPOT_LIST_EMAILSRetrieves a paginated list of HubSpot emails, allowing selection of specific properties (with or without history), associated object IDs, and filtering by archive status.

Input Parameters

string
Cursor for pagination; use paging.next.after from a previous response for the next page.
integer
Maximum number of email records per page.
boolean
Set to True to retrieve only archived emails, False (default) for non-archived emails.
array
List of valid HubSpot email property names to include. If a requested property doesn’t exist on a record, it’s omitted from that record’s response.
array
List of valid HubSpot CRM object types (e.g., ‘contact’, ‘deal’) for which to retrieve associated IDs. If an association type is invalid or doesn’t exist for an email, it’s ignored for that email.
array
List of valid HubSpot email property names to retrieve with history. If a requested property doesn’t exist, it’s ignored.

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: HUBSPOT_LIST_EVENT_OCCURRENCESLists one page of HubSpot event occurrences matching optional filters.

Input Parameters

array
Provider sort expressions controlling occurrence order.
string
Opaque cursor from a previous response’s paging.next.after value.
integer
Maximum event occurrences to return.
string
Opaque backward paging cursor returned by HubSpot.
array
Unique event occurrence IDs to retrieve.
string
Positive numeric HubSpot record ID, represented as a string.
string
Fully qualified event type to include.
array
Event property names to include in each occurrence.
string
HubSpot object type whose events to retrieve, such as contact.
string
Return occurrences at or after this ISO 8601 date and time.
string
Return occurrences at or before this ISO 8601 date and time.
object
Event property names and values used to filter occurrences.
object
Object property names and values used to filter associated records.

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: HUBSPOT_LIST_EVENT_TEMPLATESRetrieves all event templates associated with a valid appId for an existing application in HubSpot’s CRM Timeline.

Input Parameters

integer
required
The unique integer identifier for the target HubSpot application.

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: HUBSPOT_LIST_FEEDBACK_SUBMISSIONSRetrieves a paginated list of HubSpot feedback submissions, with property selection and archive-status filtering. Returned properties are limited to the response model; requested property histories and associated object IDs are not represented in it.

Input Parameters

string
The pagination token to retrieve the next page of results. This value is obtained from the paging.next.after field of a previous response. If omitted, the first page is returned. Use with limit for iterating through large sets of feedback submissions.
integer
The maximum number of feedback submissions to return per page. Using smaller values can lead to quicker responses, while larger values reduce the total number of API calls for large datasets.
boolean
Specifies whether to include archived feedback submissions. Set to True to retrieve only archived submissions. False (default) retrieves only active (non-archived) submissions. Useful for accessing historical or managing archived feedback.
array
List of HubSpot internal property names to include for each feedback submission in the response (e.g., hs_sentiment, hs_survey_name, hs_content). If specified, only these properties are returned. If a property doesn’t exist for a submission, it’s ignored. If omitted, a default set of properties is returned.
array
List of object types (e.g., contact, survey, ticket) for which to retrieve associated IDs. This allows fetching IDs of related objects. If an association doesn’t exist for a submission, it’s ignored.
array
List of HubSpot internal property names for which to include historical values. The response includes both current and past values for these properties. Requesting history may affect the number of submissions returned per page due to increased response size.

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: HUBSPOT_LIST_FORMSLists HubSpot marketing form definitions with cursor pagination.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of forms to return on this page (1-100).
boolean
Whether to return archived forms.
array
Form types to include: hubspot, captured, flow, blog_comment, or all.

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: HUBSPOT_LIST_FORM_SUBMISSIONSLists one cursor-paginated page of submissions for a HubSpot form.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Number of submissions to return on this page (1-50).
string
required
Unique GUID of the HubSpot marketing form.

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: HUBSPOT_LIST_GRANTED_SCOPESTool to introspect the current OAuth access token and return its granted scopes and metadata. Use when you need to check which permissions are available before calling an endpoint (e.g., workflows, automation) to proactively detect missing scopes and provide clear remediation guidance.

Input Parameters

boolean
Whether to include the full access token in the response. Default is false to avoid exposing sensitive token values in logs.

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: HUBSPOT_LIST_LANDING_PAGE_REVISIONSLists historical revisions of a HubSpot landing page.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of landing page revisions to return.
string
Cursor from a previous response’s paging.prev.before value.
string
required
Unique HubSpot ID of the landing page.

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: HUBSPOT_LIST_LANDING_PAGESReturn one cursor-controlled page of HubSpot landing pages.

Input Parameters

array
Page property names to sort by; prefix a property with - for descending order, for example -publishDate.
string
Cursor from paging.next.after in the previous response; omit for the first page.
integer
Maximum landing pages to return in this response.
boolean
Return archived (deleted) landing pages instead of active pages.
string
Optional landing-page property selector accepted by HubSpot.
string
Return landing pages created at this exact ISO 8601 date-time.
string
Return landing pages updated at this exact ISO 8601 date-time.
string
Return landing pages created after this ISO 8601 date-time.
string
Return landing pages updated after this ISO 8601 date-time.
string
Return landing pages created before this ISO 8601 date-time.
string
Return landing pages updated before this ISO 8601 date-time.

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: HUBSPOT_LIST_LOGIN_ACTIVITYLists HubSpot account login attempts.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of login activity records to return, from 1 to 200.
integer
Return login activity for this HubSpot user ID.

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: HUBSPOT_LIST_OBJECT_ASSOCIATIONSLists a page of associations from a single CRM record to a specified target object type without fetching the full CRM object. Use the returned paging cursor to request further pages.

Input Parameters

string
Paging cursor token from a previous response to fetch the next page of results. Leave empty to start from the first page.
integer
Maximum number of associations to return per page. Default is 500.
string
required
The unique ID of the source CRM record whose associations you want to retrieve.
string
required
Source object type (e.g., ‘deals’, ‘contacts’, ‘companies’, ‘tickets’). The object type of the record you want to list associations from.
string
required
Target object type (e.g., ‘contacts’, ‘companies’, ‘deals’). The object type you want to see associations to.

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: HUBSPOT_LIST_PRODUCTSRetrieves a paginated list of HubSpot products.

Input Parameters

string
Pagination token from previous response. Must be a valid token or omitted entirely.
integer
Maximum number of products to return per page.
boolean
Filter by archived status.
array
List of product property names to include in the response.
array
List of object types for which to retrieve associated IDs.
array
List of property names for which to retrieve historical values.

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: HUBSPOT_LIST_QUOTESRetrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object IDs, and filtering by archived status.

Input Parameters

string
Pagination token from a previous response’s paging.next.after property to fetch the subsequent page. Use the exact token provided by the API; do not modify it.
integer
Maximum number of quotes to return per page.
boolean
If true, returns only archived quotes. If false, returns only active (non-archived) quotes.
array
A list of quote property names to include in the response for each quote (e.g., hs_title, hs_quote_amount). Non-existent properties for a quote are ignored. If omitted, a default set of properties is returned.
array
A list of object types (e.g., contacts, companies, deals) for which to retrieve IDs of associated records. Non-existent association types or associations for a specific quote are ignored.
array
A list of quote property names for which historical values should be included (e.g., hs_quote_amount, hs_expiration_date). Using this may reduce the maximum number of quotes returnable per request due to increased data volume.

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: HUBSPOT_LIST_RECENTLY_MODIFIED_ENGAGEMENTSLists one page of engagements from HubSpot’s last-30-days or 10,000-most-recently-updated feed.

Input Parameters

integer
Maximum number of recently modified engagements to return, from 1 to 100.
integer
Return only engagements modified after this Unix epoch timestamp in milliseconds.
integer
Pagination offset returned by a previous response. Omit for the first page.

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: HUBSPOT_LIST_SEQUENCESLists automation sequences for a specific HubSpot user.

Input Parameters

string
Sequence name used to filter the results.
string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of sequences to return on this page.
string
required
HubSpot user ID whose sequences should be returned.

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: HUBSPOT_LIST_SETTINGS_USERSLists HubSpot account users and their provisioning details.

Input Parameters

string
Cursor from a previous response’s paging.next.after value.
integer
Maximum number of account users to return on this page.

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: HUBSPOT_LIST_SITE_PAGESReturn one cursor-controlled page of HubSpot website pages.

Input Parameters

array
Sort expressions using name, createdAt, updatedAt, createdBy, or updatedBy; prefix a field with - for descending order.
string
Cursor from paging.next.after in the previous response; omit for the first page.
integer
Maximum pages in this response. HubSpot documents a default of 100 and no numeric maximum.
boolean
Return archived (deleted) pages instead of active pages.
string
Optional page property selector accepted by HubSpot.
string
Return pages created at this exact ISO 8601 date-time.
string
Return pages updated at this exact ISO 8601 date-time.
string
Return pages created after this ISO 8601 date-time.
string
Return pages updated after this ISO 8601 date-time.
string
Return pages created before this ISO 8601 date-time.
string
Return pages updated before this ISO 8601 date-time.

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: HUBSPOT_LIST_TEAMSLists HubSpot teams and their primary and secondary user memberships.

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: HUBSPOT_LIST_TICKETSRetrieves a paginated list of HubSpot tickets.

Input Parameters

string
Pagination token from previous response.
integer
Maximum number of tickets to return per page.
boolean
Filter by archived status.
array
List of ticket property names to include in the response.
array
List of object types for which to retrieve associated IDs.
array
List of property names for which to retrieve historical values.

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: HUBSPOT_LIST_USER_ROLESLists user roles available in the connected HubSpot account.

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: HUBSPOT_MAP_LEGACY_LIST_IDTranslates a legacy HubSpot list ID to its current list ID.

Input Parameters

string
required
List ID used by the retired v1 Lists API.

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: HUBSPOT_MERGE_COMPANIESMerges two existing company records of the same type in HubSpot CRM, where objectIdToMerge is absorbed into primaryObjectId; this operation is irreversible.

Input Parameters

string
required
The ID of the company record that will be merged into the primary company record and subsequently deleted.
string
required
The ID of the company record that will remain as the primary record after the merge, absorbing the information from the other company.

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: HUBSPOT_MERGE_CONTACTSMerges two HubSpot contacts into one.

Input Parameters

string
required
The ID of the contact record that will be merged into the primary contact record. This contact will be deleted after the merge.
string
required
The ID of the contact record that will remain after the merge and will absorb the information from the contact specified by objectIdToMerge. The merged contact will retain this ID.

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: HUBSPOT_MERGE_DEALSMerges two HubSpot deals into one.

Input Parameters

string
required
The ID of the deal that will be merged into the primary deal.
string
required
The ID of the deal that will remain after the merge.

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: HUBSPOT_MERGE_EMAILSMerges two HubSpot emails into one.

Input Parameters

string
required
The ID of the email that will be merged into the primary email.
string
required
The ID of the email that will remain after the merge.

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: HUBSPOT_MERGE_FEEDBACK_SUBMISSIONSMerges two existing feedback submissions by ID, primarily for consolidating duplicates or related feedback; this operation is irreversible, and primaryObjectId values take precedence in conflicts.

Input Parameters

string
required
The unique identifier of the feedback submission to be merged into the primary one. This submission will be absorbed and typically archived or deleted after the merge process.
string
required
The unique identifier of the feedback submission that will remain as the primary record after the merge. It will contain the combined information from both submissions.

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: HUBSPOT_MERGE_LINE_ITEMSMerges two line items, objectIdToMerge into primaryObjectId, which must be of the same type; objectIdToMerge is absorbed and the operation is irreversible.

Input Parameters

string
required
The ID of the line item that will be merged into the primary line item. This line item will be absorbed and will no longer exist as a separate entity after the merge.
string
required
The ID of the primary line item that will remain after the merge. Its record will be updated with data from the line item specified by objectIdToMerge.

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: HUBSPOT_MERGE_OBJECTSMerges two distinct HubSpot CRM objects of the same objectType, consolidating data into primaryObjectId (which is preserved) and deleting objectIdToMerge; this operation is permanent and irreversible.

Input Parameters

string
required
The CRM object type (e.g., ‘contacts’, ‘companies’) of the two records to merge. Must be a valid object type in your HubSpot account.
string
required
ID of the object to be merged into the primary object and subsequently deleted.
string
required
ID of the object that will remain after the merge, into which data from objectIdToMerge is consolidated.

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: HUBSPOT_MERGE_PRODUCTSMerges two HubSpot products into one.

Input Parameters

string
required
The ID of the product that will be merged into the primary product.
string
required
The ID of the product that will remain after the merge.

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: HUBSPOT_MERGE_QUOTESMerges two distinct quotes of the same type by consolidating objectIdToMerge into primaryObjectId (e.g., for combining information or updating terms); this operation is irreversible.

Input Parameters

string
required
The unique identifier of the quote to be merged into the primary quote. This quote will be archived after the merge.
string
required
The unique identifier of the quote that will remain after the merge and will be updated with information from the other quote. Its properties take precedence in case of conflicts.

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: HUBSPOT_MERGE_TICKETSMerges two HubSpot tickets into one.

Input Parameters

string
required
The ID of the ticket that will be merged into the primary ticket.
string
required
The ID of the ticket that will remain after the merge.

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: HUBSPOT_MOVE_LIST_TO_FOLDERMove a HubSpot CRM list to a folder, including the root folder.

Input Parameters

string
required
ILS ID of the CRM list to move.
string
required
Destination folder ID. Use 0 to move the list to the root folder.

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: HUBSPOT_PARTIALLY_UPDATE_CRM_OBJECT_BY_IDPartially updates specified properties of a CRM object (e.g., contact, company, deal) identified by its type and ID, or optionally by a unique property value if idProperty is specified.

Input Parameters

string
required
Unique identifier of the CRM object. Can be provided as a string, integer, or float. If idProperty is specified, this is the value of that unique property; otherwise, it’s the internal object ID.
string
Name of a unique property (e.g., ‘email’ for contacts) to use for identifying the object instead of its internal ID. If set, objectId should be the value of this property.
string
required
Type of the CRM object to be updated.
object
required
Dictionary of properties to update. Keys are internal property names (e.g., ‘firstname’, ‘dealstage’), and values are their new values. Some properties are enum fields with specific valid values: For ‘deals’, the ‘dealstage’ property requires a valid pipeline stage ID from the deal’s pipeline (use HUBSPOT_RETRIEVE_PIPELINE_STAGES to get valid stage IDs for a pipeline). For ‘tickets’, the ‘hs_pipeline_stage’ property requires a valid ticket pipeline stage ID. For other enum properties, use HUBSPOT_READ_A_CRM_PROPERTY_BY_NAME to discover valid options.

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: HUBSPOT_PERMANENTLY_DELETE_CONTACT_VIA_GDPRPermanently deletes a HubSpot contact and all its associated data for GDPR compliance, identifying the contact by its ID or another unique property.

Input Parameters

string
required
The unique identifier of the contact to be permanently deleted. This could be the contact’s HubSpot ID or another unique property value (e.g., email address) if idProperty is specified.
string
The name of the property that contains the unique identifier of the contact specified in objectId. For example, if objectId is an email address, set this to ‘email’. If objectId is the HubSpot contact ID, this field can be omitted (or set to None).
string
required
The type of HubSpot object to be deleted. Must be ‘contacts’ for this GDPR deletion endpoint. This parameter is part of the URL path.

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: HUBSPOT_PUBLISH_LANDING_PAGE_DRAFTApply draft changes to the live version of a HubSpot landing page.

Input Parameters

string
required
Unique HubSpot ID of the landing page whose draft to publish.

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: HUBSPOT_PUBLISH_MARKETING_EMAILPublishes or sends a specified HubSpot marketing email that is valid and ready for sending; requires Marketing Hub Enterprise or the transactional email add-on.

Input Parameters

string
required
Identifier of the HubSpot marketing email to publish or send.

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: HUBSPOT_PUBLISH_SITE_PAGE_DRAFTApply draft changes to the live version of an already published HubSpot site page.

Input Parameters

string
required
Unique HubSpot ID of the site page whose draft to publish.

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: HUBSPOT_PURGE_SCHEMAPermanently and irreversibly deletes the schema for an existing objectType in HubSpot CRM; this deprecated endpoint should be used with extreme caution.

Input Parameters

string
required
The specific object type (e.g., ‘contacts’, ‘companies’, or a custom object ID) for which the schema will be permanently deleted. Must be an exact, case-sensitive match to a valid object type defined in HubSpot.

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: HUBSPOT_READ_A_CRM_PROPERTY_BY_NAMEReads a specific CRM property definition for a given HubSpot object type by its internal name.

Input Parameters

boolean
If true, retrieves an archived property definition; retrieves active property definitions by default.
string
required
Specifies the CRM object type (e.g., ‘contacts’, ‘deals’) for which the property is retrieved.
string
Optional comma-separated list of additional property attributes to return; consult HubSpot API documentation for available attributes and format.
string
required
The internal, unique name of the property to retrieve (e.g., ‘firstname’, ‘dealname’).

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: HUBSPOT_READ_ALL_PROPERTIES_FOR_OBJECT_TYPERetrieves definitions and metadata (not actual values) for properties of a specified HubSpot CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom objects).

Input Parameters

boolean
Filter properties by their archived status: true for archived, false for active (non-archived).
string
required
Identifier for the CRM object type (e.g., ‘contacts’, ‘companies’). Must be a valid, case-sensitive object type name existing in HubSpot.
string
DEPRECATED/NON-FUNCTIONAL: This parameter appears in the API but does not work as expected. When provided, the API returns empty property objects instead of filtered results. Leave this parameter unset (None) to retrieve all properties.

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: HUBSPOT_READ_APAGE_OF_OBJECTS_BY_TYPERetrieves a paginated list of objects for a specified and valid HubSpot CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom ID).

Input Parameters

string
Pagination token from a previous response’s paging.next.after property, used to fetch the next page of results.
integer
Maximum number of results to return per page (must be an integer between 1 and 100).
boolean
Set to true to retrieve only archived objects. If false or omitted (default), non-archived objects are returned.
string
required
Identifier for the type of CRM object to retrieve (e.g., ‘contacts’, ‘companies’, ‘deals’, or a custom object type ID).
array
List of property names to include for each object; non-existent properties on an object are ignored. Customizes response and can reduce payload size.
array
List of object types (e.g., ‘companies’, ‘deals’) for which to retrieve associated IDs. Only existing associations are returned.
array
List of property names for which to include historical values. Using this parameter may reduce the maximum number of objects returnable in a single request.

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: HUBSPOT_READ_ASSOCIATIONS_BATCHTool to batch-read CRM associations (e.g., deals→contacts, deals→companies) for up to 1,000 source record IDs in one request. Use when you need to retrieve associated target IDs and association type metadata for multiple records efficiently, avoiding rate-limit issues from per-record GET calls.

Input Parameters

array
required
List of source record IDs to retrieve associations for (max 1,000 per request). Each input can include an optional ‘after’ cursor for per-source pagination.
string
required
Target object type for associations. Use standard names (e.g., ‘contacts’, ‘companies’, ‘deals’) or object type IDs (e.g., ‘0-1’ for contacts). For custom objects, use their objectTypeId.
string
required
Source object type for associations. Use standard names (e.g., ‘deals’, ‘contacts’, ‘companies’, ‘tickets’) or object type IDs (e.g., ‘0-3’ for deals). For custom objects, use their objectTypeId (e.g., ‘2-12345’).

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: HUBSPOT_READ_BATCH_CRM_OBJECT_PROPERTIESRetrieves property definitions (metadata) for a batch of CRM object properties for a specified object type. Returns detailed information about property structure, data types, options, and configuration—not the actual property values of CRM records.

Input Parameters

array
required
A list of property identifiers, each specifying the ‘name’ of a property whose definition should be retrieved for the given objectType.
boolean
required
If true, retrieves only archived property definitions; otherwise, retrieves non-archived definitions.
string
required
The case-sensitive CRM object type (e.g., ‘contacts’, ‘companies’) for which properties are being read, matching the type in your HubSpot account.
string
Optional filter to retrieve only properties with a specific data sensitivity level. Valid values: ‘highly_sensitive’, ‘sensitive’, ‘non_sensitive’.

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: HUBSPOT_READ_BATCH_FEEDBACK_SUBMISSIONS_BY_ID_OR_PROPERTYRetrieves up to 100 feedback submissions in a batch using their IDs or a specified unique idProperty, optionally including specified properties and their history.

Input Parameters

array
required
Identifiers for feedback submissions to retrieve, using primary ‘id’ or idProperty.
boolean
Set to true to retrieve only archived submissions; false (default) for active submissions.
string
Unique identifier property name to use instead of ‘id’; inputs should contain values for this property if provided.
array
Property names to return for each feedback submission; defaults if not specified.
array
Property names for which to retrieve historical values; past values are included if updated.

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: HUBSPOT_READ_BATCH_OF_CRM_OBJECTS_BY_ID_OR_PROPERTY_VALUESReads a batch of CRM objects of a specified objectType using their HubSpot IDs or unique property values from the inputs list, allowing retrieval of specific properties, their historical values (propertiesWithHistory), and filtering by archived status.

Input Parameters

array
required
List of objects, each with an ‘id’ identifying a CRM object to retrieve, using the HubSpot object ID or the value of idProperty.
boolean
If true, retrieves only archived CRM objects; if false (default), retrieves non-archived objects.
string
Alternate unique identifier property name (e.g., ‘email’ for contacts) to use instead of the default object ID.
string
required
Type of CRM object to read (e.g., ‘contacts’, ‘companies’). Determines which object collection to query.
array
required
List of property names to return for each CRM object. If omitted, default properties are returned.
array
required
List of property names for which to retrieve historical values.

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: HUBSPOT_READ_BATCH_OF_LINE_ITEMS_BY_ID_OR_PROPERTY_VALUESRetrieves a batch of HubSpot CRM line items by their IDs, or optionally by values of a custom unique property defined in idProperty.

Input Parameters

array
required
A list of objects, where each object contains the ‘id’ of a line item to retrieve. The ‘id’ can be the line item’s unique ID or the value of the property specified in idProperty.
boolean
Whether to return only archived line items. If true, returns only archived line items; if false (default), returns only non-archived line items.
string
The name of a property whose values are unique for that object type. Use this if you want to identify line items by a custom unique property instead of the default ‘id’.
array
required
A list of property names to be returned in the response. If not specified, all readable properties will be returned.
array
required
A list of property names for which to return historical values; if a property has been updated, the response includes its previous values.

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: HUBSPOT_READ_BATCH_OF_QUOTES_BY_PROPERTY_VALUESEfficiently retrieves a batch of HubSpot CRM quotes by their IDs (or a specified unique property), optionally including archived quotes, specific properties, and property history.

Input Parameters

array
required
A list of objects, each specifying a quote to retrieve. Each object must contain an id field that holds the identifier of the quote, corresponding to idProperty or the primary object ID.
boolean
Specifies whether to include archived quotes in the results. If true, only archived quotes are returned. If false (default) or omitted, only active (non-archived) quotes are returned.
string
The name of the property to use as the unique identifier for the quotes specified in the inputs list. If omitted, the quote’s primary object ID (e.g., hs_object_id) is used. This property must be a unique identifier for quotes.
array
required
A list of internal names of quote properties to be included in the response for each quote. If omitted, a default set of properties is returned by HubSpot. Refer to HubSpot documentation for default properties.
array
required
A list of internal names of quote properties for which historical values should be retrieved. The response will include the history of changes for these properties.

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: HUBSPOT_READ_BUDGETRetrieves budget totals for a specified HubSpot marketing campaign by its campaign ID.

Input Parameters

string
required
The unique identifier (UUID) of the marketing campaign for which to retrieve budget information.

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: HUBSPOT_READ_CONTACTRetrieves a HubSpot contact by its ID.

Input Parameters

boolean
Set to true to include only archived contacts; defaults to false (active contacts).
string
required
Unique internal HubSpot CRM object ID for the contact, which must be valid and existing.
array
Contact property names to include in the response; if omitted, all available properties are returned.
array
Object types (e.g., ‘companies’, ‘deals’) to include associated object IDs in the response.
array
Property names for which to include current and historical values 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: HUBSPOT_READ_CONTACTSBatch read multiple HubSpot contacts by their IDs or custom identifier property. This action retrieves up to 100 contacts per request using the HubSpot CRM batch read API. You can specify which contact properties to return and optionally include historical values for properties.

Input Parameters

array
required
A list of contact identifiers to retrieve. Each object in the list should contain an id (or the idProperty if specified) of a contact.
boolean
Specifies if only archived contacts should be returned (true), or only non-archived contacts (false).
string
The name of an alternate unique identifier property to use for retrieving contacts. If specified, the inputs objects should provide values for this property instead of the default id.
array
Contact property names to include in the response. Optional - a default set is returned if unspecified.
array
Contact property names for which to retrieve historical values. Optional - omit if history is not needed.

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: HUBSPOT_READ_CRM_OBJECT_BY_IDRetrieves a specific CRM object (e.g., contact, company, deal, ticket) by its ID or a unique property, optionally including specific properties, history, and associations.

Input Parameters

boolean
Set to true to retrieve only archived objects. Defaults to false (non-archived objects).
string
required
The unique identifier of the CRM object, or the value of the unique property if idProperty is specified. Accepts both string and numeric values (numeric IDs are converted to strings automatically).
string
The name of a unique property (e.g., ‘email’ for contacts, ‘domain’ for companies) to use for lookup instead of the internal object ID. If omitted, the internal object ID is used.
string
required
The type of CRM object to retrieve. Valid standard object types are: ‘contacts’, ‘companies’, ‘deals’, ‘tickets’, ‘line_items’, ‘products’, ‘quotes’, ‘calls’, ‘emails’, ‘meetings’, ‘notes’, ‘tasks’, ‘postal_mail’, ‘communications’, ‘feedback_submissions’, ‘goals’, ‘leads’, ‘invoices’, ‘subscriptions’, ‘orders’, ‘payments’, ‘carts’, ‘appointments’, ‘courses’, ‘listings’, ‘services’, ‘users’. You can also use numeric object type IDs (e.g., ‘0-1’ for contacts, ‘0-2’ for companies, ‘0-3’ for deals, ‘0-5’ for tickets). For custom objects, use ‘p_{internal_name}’ format or the objectTypeId (e.g., ‘2-12345’). Note: ‘owners’ is NOT a valid object type - use the dedicated Owners API instead.
array
A list of property names to include in the response. Non-existent properties are ignored. If omitted, a default set of properties is returned.
array
A list of object types (e.g., ‘contacts’, ‘companies’) for which to retrieve associated IDs (e.g., to get associated companies for a contact). Non-existent associations are ignored.
array
A list of property names to retrieve value history for, showing changes over time. Non-existent properties or those without history are ignored.

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: HUBSPOT_READ_EMAILRetrieves an existing HubSpot CRM email object by its email ID or by the value of an alternative unique property, with the property name specified separately.

Input Parameters

string
required
The unique identifier (HubSpot ID) of the email object to retrieve, or the value of the idProperty if specified.
boolean
Set to true to retrieve only archived email objects.
string
Name of an alternative unique property to identify the email if not using emailId.
array
Specific email properties to include; non-existent properties are ignored.
array
Object types (e.g., ‘contact’, ‘company’) for associated IDs; non-existent associations are ignored.
array
Email properties for which to retrieve historical values; non-existent properties are ignored.

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: HUBSPOT_READ_FEEDBACK_SUBMISSION_BY_IDReads a HubSpot feedback submission by ID or a custom unique property, with selected properties and property history. The returned properties are limited to the fields represented in the response model.

Input Parameters

boolean
Set to true to retrieve only archived submissions; false (default) retrieves active ones.
string
Name of a unique property (e.g., ‘survey_response_id’) to use as the identifier instead of the internal object ID. Its values must be unique.
array
Specific feedback submission property names to include in the response; HubSpot ignores non-existent ones.
array
Object types (e.g., ‘CONTACT’) for which to retrieve associated IDs; HubSpot ignores non-existent associations.
string
required
Identifier of the feedback submission to retrieve; use a custom property value if ‘idProperty’ is set. Must be an existing submission.
array
Feedback submission property names for which to include a history of values; HubSpot ignores non-existent ones.

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: HUBSPOT_READ_LEGACY_CONTACT_PROFILERetrieve one legacy HubSpot contact profile by VID when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.

Input Parameters

string
required
Legacy HubSpot contact VID.
array
Contact property names to return. Each name is sent as a repeated property query parameter.
string ("value_only" | "value_and_history")
Whether returned properties contain only current values or current values and history.
string ("all" | "none" | "newest" | "oldest")
Which form submissions to include in the contact profile.

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: HUBSPOT_READ_LEGACY_CONTACT_PROFILES_BY_EMAILBatch-read up to 100 legacy HubSpot contact profiles by email when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.

Input Parameters

array
required
Email addresses whose legacy contact profiles should be returned. Include between 1 and 100 addresses.
array
Contact property names to return. Each name is sent as a repeated property query value.
string ("value_only" | "value_and_history")
Whether properties contain only their current value or their current value and history.
string ("all" | "none" | "newest" | "oldest")
Which legacy form submissions to include in each contact profile.

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: HUBSPOT_READ_LEGACY_CONTACT_PROFILES_BY_VIDBatch-read up to 100 legacy HubSpot contact profiles by VID when legacy-shaped profile data is needed.

Input Parameters

array
required
Legacy contact VIDs whose profiles should be returned. Include between 1 and 100 VIDs.
array
Contact property names to return. Each name is sent as a repeated property query value.
string ("value_only" | "value_and_history")
Whether properties contain only their current value or their current value and history.
string ("all" | "none" | "newest" | "oldest")
Which legacy form submissions to include in each contact profile.
boolean
Whether to include legacy list memberships. Defaults to false because HubSpot normally returns this retired field as null.

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: HUBSPOT_READ_PROPERTY_GROUPRetrieves metadata for a specific property group of a given CRM object type, detailing its structure and attributes, but not the actual property values of CRM objects.

Input Parameters

string
required
Unique identifier (name) of the property group to retrieve. These names are case-sensitive and often use lowercase letters and underscores.
string
required
The type of CRM object for which to retrieve the property group.

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: HUBSPOT_READ_PROPERTY_GROUPS_FOR_OBJECT_TYPERetrieves all property groups in a single call for a specified HubSpot CRM object type (e.g., ‘contacts’, ‘companies’), returning only the groups themselves, not the individual properties within them.

Input Parameters

string
required
Specifies the HubSpot CRM object type for which property groups will be retrieved.

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: HUBSPOT_REMOVE_ASSET_ASSOCIATIONDisassociates an asset from a HubSpot marketing campaign. Supports a wide range of asset types including forms, landing pages, emails, blog posts, workflows, static lists, and more.

Input Parameters

string
required
The unique identifier of the asset.
string
required
The category/type of asset to disassociate from the campaign. Supported types include: AD_CAMPAIGN, BLOG_POST, CALL, CASE_STUDY, CTA, CTA_LEGACY, EXTERNAL_WEB_URL, FEEDBACK_SURVEY, FORM, FILE, KNOWLEDGE_BASE_ARTICLE, LANDING_PAGE, MARKETING_EMAIL, MARKETING_EVENT, MEETING_EVENT, PLAYBOOK, PODCAST_EPISODE, SALES_DOCUMENT, SALES_EMAIL, SEQUENCE, MARKETING_SMS, SOCIAL_POST, OBJECT_LIST (static lists), VIDEO, WEBSITE_PAGE, AUTOMATION_PLATFORM_FLOW (workflows), and others.
string
required
The unique identifier (UUID) of the HubSpot campaign.

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: HUBSPOT_REMOVE_ASSOCIATIONTool to remove all associations between two CRM records using the v4 associations endpoint. Use when unlinking records or cleaning up incorrect associations.

Input Parameters

string
required
ID of the source CRM record.
string
required
Source object type (e.g., ‘contacts’, ‘deals’, ‘companies’, ‘tickets’).
string
required
ID of the target CRM record.
string
required
Target object type (e.g., ‘companies’, ‘contacts’, ‘deals’, ‘tickets’).

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: HUBSPOT_REMOVE_ASSOCIATION_FROM_SCHEMAPermanently removes a specified association definition (type) from a HubSpot object’s schema, preventing future creations of this association type without affecting existing instances.

Input Parameters

string
required
The fully qualified name or ID of the HubSpot object schema from which to remove the association definition.
string
required
The unique ID of the association definition to remove from the specified object schema.

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: HUBSPOT_REMOVE_CONTACT_SECONDARY_EMAILRemoves one secondary email address from a HubSpot contact identified by its legacy contact VID.

Input Parameters

string
required
Secondary email address to remove from the contact.
string
required
Legacy HubSpot contact VID, represented as a string to preserve 64-bit values.

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: HUBSPOT_REMOVE_DEALRemoves a HubSpot deal by its ID.

Input Parameters

string
required
Unique HubSpot identifier for the deal to be removed.

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: HUBSPOT_REMOVE_SETTINGS_USERRemove a provisioned HubSpot account user by user ID or email.

Input Parameters

string
required
User ID or email identifying the HubSpot account user to remove.
string ("USER_ID" | "EMAIL")
Property used to identify the account user. Defaults to USER_ID; use EMAIL when user_id contains an email address.

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: HUBSPOT_REMOVE_TOKEN_FROM_EVENT_TEMPLATERemoves a token from a HubSpot event template, preventing its inclusion in new events created from that template.

Input Parameters

integer
required
The unique identifier of the target application associated with the event template. Must be a valid integer representing the ID of your HubSpot app.
string
required
The name of the token to be removed from the event template. Must be a string that exactly matches an existing token’s name within the specified template (case-sensitive).
string
required
The unique identifier of the event template from which the token will be removed. Must be a valid string representing an existing event template ID in your HubSpot account.

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: HUBSPOT_RENAME_CRM_LISTRenames an existing HubSpot CRM list.

Input Parameters

string
required
ID of the CRM list to rename.
string
required
New portal-wide unique name for the CRM list.
boolean
Whether to include the list’s filter definition 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: HUBSPOT_RENDER_EVENT_DETAIL_TEMPLATERenders detailed information for a specific HubSpot CRM timeline event using a predefined event template, ignoring extraData references in the template not present in event data.

Input Parameters

string
required
The unique ID for a specific HubSpot CRM timeline event to render.
string
required
The unique ID for an existing HubSpot event template to use for rendering.

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: HUBSPOT_RENDER_EVENT_HEADER_OR_DETAIL_AS_HTMLRenders an event’s header or detail template as HTML for a specified event on the HubSpot CRM timeline, using a given event template ID and event ID.

Input Parameters

boolean
If true, renders the detailTemplate; if false or not provided, renders the headerTemplate.
string
required
The unique identifier for an existing event on the HubSpot timeline whose data will be used in the rendering.
string
required
The unique identifier for an existing event template to be used for rendering.

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: HUBSPOT_REPLACE_ALL_PROPERTIES_OF_PIPELINEOverwrites an entire CRM pipeline (specified by objectType and pipelineId) and all its stages with a new definition, returning the updated pipeline.

Input Parameters

string
required
Unique label for this pipeline, for UI organization.
array
required
A list of stage definitions that will completely replace all existing stages in the pipeline.
string
required
Identifies the CRM object type (e.g., ‘deals’, ‘tickets’) for the pipeline being updated.
string
required
Unique ID of the pipeline to update, specific to its objectType.
integer
required
Display order for this pipeline; those with the same order are sorted alphabetically by label.
boolean
If true, validates existing references to the pipeline before updating to prevent issues from modifying referenced stages.
boolean
If true and objectType is ‘deals’, checks deal stage usage before modification/deletion to prevent data issues.

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: HUBSPOT_REPLACE_PIPELINE_STAGE_PROPERTIESReplaces all properties of a specified pipeline stage; the new label must be unique within the pipeline, and if objectType is ‘deals’, the metadata must include a ‘probability’ key.

Input Parameters

string
required
A new label for the pipeline stage.
string
required
Unique identifier of the specific pipeline stage to be updated, assigned by HubSpot and unique to the stage within its pipeline.
object
required
Key-value pairs for custom stage properties; all values must be strings. For ‘deals’ objectType, ‘probability’ (string: number from 0.0-1.0 in 0.1 increments, e.g., ‘0.5’) is required. For ‘tickets’ objectType, ‘ticketState’ (string: ‘OPEN’ or ‘CLOSED’) is optional.
string
required
The CRM object type associated with the pipeline (e.g., ‘deals’ for sales pipelines, ‘tickets’ for support pipelines).
string
required
Unique identifier of the pipeline, assigned by HubSpot when the pipeline is created.
integer
required
The display order for this pipeline stage. Stages with the same displayOrder value are sorted alphabetically by their label. Use -1 to place the stage at the end.

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: HUBSPOT_RESET_DRAFTResets a marketing email’s draft to its currently published (live) version, discarding all unpublished changes; the email must have a live version to revert to.

Input Parameters

string
required
Identifier of the marketing email whose draft will be reset to its currently published (live) version.

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: HUBSPOT_RESTORE_EMAIL_REVISIONRestores a specific revision of a marketing email to a DRAFT state, overwriting any existing draft.

Input Parameters

string
required
The unique identifier of the marketing email.
integer
required
The specific revision ID of the marketing email to restore.

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: HUBSPOT_RESTORE_MARKETING_EMAIL_REVISIONRestores a specific, existing, non-active revision of a marketing email to become the new live version for that email.

Input Parameters

string
required
Identifier of the marketing email.
string
required
Identifier of the specific email revision to restore.

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: HUBSPOT_RETRIEVE_ALL_OBJECT_SCHEMASRetrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas.

Input Parameters

boolean
Set to true to retrieve only archived object schemas, or false for only active, non-archived schemas. Archived schemas are typically inactive but retained for historical/compliance.

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: HUBSPOT_RETRIEVE_ALL_PIPELINES_FOR_SPECIFIED_OBJECT_TYPERetrieves all pipelines in HubSpot for a specified CRM object type, such as deals or tickets.

Input Parameters

string
required
The case-sensitive CRM object type (e.g., ‘deals’, ‘tickets’) for which to retrieve pipelines; must support pipelines.

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: HUBSPOT_RETRIEVE_CALLING_SETTINGS_FOR_APPRetrieves the read-only calling extension settings for a specific HubSpot app; the app must exist and have calling extensions configured.

Input Parameters

integer
required
The unique integer identifier for the target HubSpot app.

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: HUBSPOT_RETRIEVE_LINE_ITEM_BY_IDRetrieves a HubSpot CRM line item by its ID or a specified unique property (idProperty).

Input Parameters

boolean
Set to True to retrieve archived Line Items; False (default) retrieves non-archived items.
string
Name of a unique property (e.g., ‘sku’) to use as the identifier instead of the HubSpot ID. Must be unique across all Line Items.
string
required
The Line Item’s unique identifier. Must be a valid numeric HubSpot object ID of an existing line item, or the value of the property specified in idProperty. Use HUBSPOT_RETRIEVE_LINE_ITEMS_LIST or HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIA to find valid IDs.
array
Optional list of property names to return for the Line Item. Non-existent properties are ignored.
array
Optional list of object types (e.g., ‘deal’) for which to retrieve IDs of associated objects. Ignores non-existent association types.
array
Optional list of property names for which to retrieve historical values. Ignores non-existent properties or those without history.

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: HUBSPOT_RETRIEVE_LINE_ITEMSFetches a paginated list of HubSpot CRM line items, with archive filtering and optional associated object IDs. Returned properties are limited to the fields supported by the response model; requested property history is not retained.

Input Parameters

string
Pagination token from ‘paging.next.after’ of a previous response to fetch the subsequent page. Omit for the first request.
integer
Maximum number of line items to return per page; controls response size. An API-defined upper limit may apply.
boolean
Filter by archive status: true for archived only, false (default) for active only. Manages historical or current items.
array
Property names to include for each line item (e.g., ["name", "price"]); customizes returned data. Non-existent properties are ignored. If omitted, a default set is returned.
array
Object types (e.g., ["deal", "product"]) for which to retrieve associated IDs. Invalid types are ignored. Valid types depend on HubSpot data model.
array
Property names for which to include historical values (e.g., ["status", "amount"]); tracks changes. May reduce items returned per request due to increased payload.

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: HUBSPOT_RETRIEVE_OBJECT_SCHEMAFetches the detailed schema definition for a specified, existing standard or custom HubSpot CRM object type; this action is read-only and does not create or modify schemas.

Input Parameters

string
required
Fully qualified name for standard HubSpot objects (e.g., ‘contacts’, ‘companies’) or unique object type ID for custom objects (e.g., ‘p123456’, ‘2-xxxxxxx’). Case-sensitive and must match an existing object type as defined in HubSpot.

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: HUBSPOT_RETRIEVE_OWNER_BY_ID_OR_USER_IDRetrieves a specific HubSpot CRM owner by their ID, with options to specify ID type (owner or user) and to include archived records.

Input Parameters

integer
required
Unique identifier of the owner. Its meaning (HubSpot owner ID or user ID) is determined by idProperty.
boolean
Set to true to retrieve only archived owners; otherwise, active (non-archived) owners are returned.
string ("id" | "userId")
Determines if ownerId refers to the HubSpot owner ID (id) or the user ID (userId).

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: HUBSPOT_RETRIEVE_OWNERSRetrieves a page of HubSpot CRM owners, including their ID, name, email, and user ID. The response may include paging information, but this action does not accept a cursor to retrieve further pages.

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: HUBSPOT_RETRIEVE_PAGE_OF_CRM_OWNERSRetrieves a paginated list of CRM owners from HubSpot, optionally filtering by email or archived status.

Input Parameters

string
Pagination token from a previous response to fetch the next page.
string
Filter by a specific email address.
integer
Maximum number of CRM owners per page. Refer to HubSpot’s API documentation for current limits.
boolean
Set to true for archived owners, or false for active owners.

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: HUBSPOT_RETRIEVE_PIPELINE_STAGE_BY_IDRetrieves details and metadata for a specific HubSpot CRM pipeline stage identified by object type, pipeline ID, and stage ID.

Input Parameters

string
required
The unique identifier (ID) of the specific pipeline stage to retrieve. This ID must be valid and exist within the specified pipeline.
string
required
The type of CRM object associated with the pipeline (e.g., ‘deals’, ‘tickets’). This is case-sensitive and determines which object-specific pipeline and stages are queried. Must be a valid HubSpot CRM object type.
string
required
The unique identifier (ID) of the pipeline containing the stage. This ID must be valid and correspond to the specified objectType.

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: HUBSPOT_RETRIEVE_PIPELINE_STAGESFetches all stages for a specified HubSpot CRM object type and pipeline ID.

Input Parameters

string
required
The CRM object type (e.g., deals, tickets) for which to retrieve pipeline stages; must support pipelines.
string
required
The unique ID of the pipeline associated with the specified objectType whose stages are to be retrieved.

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: HUBSPOT_RETRIEVE_TIMELINE_EVENT_BY_IDSRetrieves a specific HubSpot CRM timeline event by its application ID, event template ID, and event ID, returning event details including timestamp, tokens, and associated object information.

Input Parameters

string
required
The unique identifier for the specific timeline event. This ID uniquely identifies the event within the context of its template and must correspond to an existing event in your HubSpot CRM timeline.
string
required
The HubSpot application ID that created the timeline event. This is the ID of the developer app or integration that generated the timeline events you want to retrieve.
string
required
The unique identifier for the event template (also called event type ID). This ID is crucial for locating the specific type of event and must correspond to a pre-defined event template in your HubSpot account.

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: HUBSPOT_RETRIEVE_VIDEO_CONFERENCE_SETTINGS_BY_IDRetrieves video conference application settings for a specified app, including meeting webhook URLs and a user verification URL.

Input Parameters

integer
required
The unique integer identifier for the video conference application, corresponding to the ID of the application created in your HubSpot developer portal.

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: HUBSPOT_SCHEDULE_BLOG_POSTSchedules a HubSpot blog post to publish at a specified date and time.

Input Parameters

string
required
ID of the HubSpot blog post to schedule.
string
required
Date and time when HubSpot should publish the blog post, in ISO 8601 format.

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: HUBSPOT_SCHEDULE_LANDING_PAGESchedules a HubSpot landing page to publish at a specified date and time.

Input Parameters

string
required
ID of the HubSpot landing page to schedule.
string
required
Date and time when HubSpot should publish the landing page, in ISO 8601 format.

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: HUBSPOT_SEARCH_CAMPAIGNSSearches for HubSpot campaigns.

Input Parameters

string
Pagination token from previous response.
integer
Maximum number of campaigns to return.
string
Text search query to find campaigns by name.

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: HUBSPOT_SEARCH_CMS_CONTENTSearch HubSpot’s indexed CMS content.

Input Parameters

string
Text to search for in HubSpot’s indexed CMS content.
string ("SITE_PAGE" | "LANDING_PAGE" | "BLOG_POST" | "LISTING_PAGE" | "KNOWLEDGE_ARTICLE" | "STRUCTURED_CONTENT")
Single CMS content type to include in the search.
integer
Maximum results in this response (1-100).
array
Domains whose indexed CMS content should be searched.
string ("SHORT" | "LONG")
Length of each result description: SHORT or LONG.
integer
Zero-based result offset; advance by the returned limit to continue.
array
Blog IDs to restrict the search to, passed as digit strings to preserve 64-bit values.
string
Content language as an ISO 639-1 code, optionally with a region.
array
Indexed properties to search; all are searched when omitted.
string
HubDB table ID to restrict search results to, passed as a digit string to preserve 64-bit values.
boolean
Whether HubSpot should record analytics for this search.
number
Maximum view-count-based score boost.
string
HubDB query used to further filter HubDB search results.
string
Return only results whose URL path starts with this prefix.
boolean
Whether the request is for autocomplete results.
string
Recency window such as 10d; supported units are ms, s, m, h, and d.
boolean
Whether path_prefix matches paths that start with the supplied value.
number
Strength of the view-count-based popularity boost.

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: HUBSPOT_SEARCH_COMPANIESSearches for HubSpot companies using flexible criteria and filters.

Input Parameters

string
Pagination cursor; use paging.next.after from a previous response to fetch the next page.
integer
Maximum number of company records to return.
string
String to search across default text properties of company records.
array
List of sort objects to define the order of results. Maximum 1 sort allowed.
array
HubSpot company property internal names to include in the response. Supports both standard properties and custom properties; a default set is returned if unspecified.
array
Groups of filters to apply to the ticket search.
array
List of filter groups; filters within a group are ANDed, and multiple groups are ORed.
array
Custom company property internal names to include 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: HUBSPOT_SEARCH_CONTACTS_BY_CRITERIASearches for HubSpot contacts using a text query, specific filter criteria (filters in a group are ANDed, groups are ORed), sorting, and pagination to retrieve selected properties.

Input Parameters

string
The cursor token for pagination. Use the after value from the paging.next object of a previous response to fetch the next set of results. If None or an empty string, it fetches the first page.
integer
The maximum number of contacts to return.
string
A string to search across HubSpot’s default searchable contact properties ONLY: firstname, lastname, email, phone, hs_additional_emails, hs_object_id, hs_searchable_calculated_phone_number, company. IMPORTANT: This does NOT search custom properties. To search/filter by custom properties (e.g., ‘icp_segment’, ‘lead_source’), use filterGroups with specific property filters instead. At least one of ‘query’ or ‘filterGroups’ must be provided.
array
A list of sort criteria to apply. Each criterion specifies a contact propertyName and a sort direction. Example: [{'propertyName': 'lastname', 'direction': 'ASCENDING'}] sorts contacts by last name.
array
A list of contact property internal names to include in the response. Supports both standard properties (firstname, email, etc.) and custom properties. If omitted, a default set is returned.
array
A list of filter groups. HubSpot enforces strict limits: maximum 5 filterGroups and maximum 18 total filters across all groups combined. Filters within a group are ANDed. Multiple groups are ORed. Use filterGroups to search/filter by ANY property (including custom properties) with precise operators. At least one of ‘query’ or ‘filterGroups’ must be provided. For custom property filtering (e.g., icp_segment=‘Construction’), use filterGroups instead of query. Example: [{'filters': [{'propertyName': 'icp_segment', 'operator': 'EQ', 'value': 'Construction'}]}]. If you need more filter groups or filters, split your search into multiple requests.
array
A list of internal names for custom contact properties to retrieve (e.g., custom_lead_score). This is a convenience alias that gets merged into properties before the API call - you can also include custom properties directly in the properties field instead.

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: HUBSPOT_SEARCH_CRM_LISTSSearches and pages through HubSpot CRM list definitions.

Input Parameters

string
List field and order to sort by, using HubSpot’s list search syntax.
integer
Number of lists to return, from 1 to 500.
string
Text to match against list names. Leave empty to page through all lists.
integer
Pagination offset from a previous search response. Use 0 for the first page.
array
ILS list IDs to include. Omit or pass an empty list to avoid filtering by list ID.
string
HubSpot object type ID whose lists should be returned, such as 0-1 for contacts.
array
List processing types to include: MANUAL, SNAPSHOT, or DYNAMIC.
array
Additional list property names to include in each result.

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: HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIASearches HubSpot CRM objects by object type using a text query or filter groups, with sorting and pagination. At least one query or filter group is required; property names must be valid for the specified object type.

Input Parameters

string
Optional. Cursor for pagination (from previous response). Must be formatted as an integer string (e.g., ‘100’, ‘200’). HubSpot’s search API has a hard limit of 10,000 total results; pagination cannot proceed beyond this point (i.e., after >= 10000 is not allowed).
integer
Optional. Max results per page (default 10, max 100).
string
A string for a broad search across multiple fields on the object. Use this for quick text searches. Optional - can be omitted to retrieve all objects.
array
Optional. List of sort rules. Accepts either simple strings (e.g., ‘createdate’ for ascending, ‘-createdate’ for descending) or object format [{‘propertyName’: ‘createdate’, ‘direction’: ‘ASCENDING’}]. Simple strings are automatically converted to the object format. Only one sorting rule can be applied to any search.
string
required
The type of CRM object to search. VALID VALUES: ‘contacts’, ‘companies’, ‘deals’, ‘tickets’, ‘tasks’, ‘line_items’, ‘products’, ‘quotes’, ‘calls’, ‘emails’, ‘meetings’, ‘notes’, or custom object IDs like ‘2-1234567’. Must be lowercase and plural for standard types. IMPORTANT: This is the OBJECT TYPE, not a property name. Do NOT pass property names like ‘hs_task_status’, ‘email’, ‘dealname’, etc. here - those belong in filterGroups.filters.propertyName. Example: To search for tasks with a specific status, use objectType=‘tasks’ and add a filter with propertyName=‘hs_task_status’.
array
Optional. List of property names to include in the response. Property names must be valid for the objectType. For tasks: use hs_task_subject, hs_task_body, hs_task_status, hs_task_priority, hs_timestamp (due date), hs_task_type, hubspot_owner_id. Do NOT use hs_status, hs_due_date, or hs_priority for tasks. Note: Properties filtered with HAS_PROPERTY or NOT_HAS_PROPERTY operators cannot be included here and will be automatically removed.
array
Optional. List of filter groups (AND within, OR between). Can be omitted to retrieve all objects without filtering. Maximum of 5 filter groups with up to 6 filters each (18 total).

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: HUBSPOT_SEARCH_DEALSSearches for HubSpot deals using flexible criteria and filters.

Input Parameters

string
Pagination token from a previous response’s paging.next.after to fetch the next page; omit for the first page. Note: HubSpot’s search API has a hard limit of 10,000 total results - the ‘after’ value must be less than 10000.
integer
Maximum number of deal records to return.
string
String to search across default text properties in deals for records containing this string.
array
Sort order for results. If multiple sort objects are provided, they are applied in the given order.
array
HubSpot deal property internal names to include in the response. Supports both standard and custom properties; a default set is returned if omitted.
array
Filter groups to apply to the search. Filters within a group are ANDed; groups are ORed.
array
User-defined custom property internal names (not standard HubSpot properties) to include 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: HUBSPOT_SEARCH_EMAILSSearches HubSpot CRM email engagement records using a text query, with selectable properties and paginated results.

Input Parameters

string
Pagination token from previous response.
integer
Maximum number of emails to return.
string
Text search query to find emails by subject or content.
array
Email property names to include 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: HUBSPOT_SEARCH_FEEDBACK_SUBMISSIONSSearches HubSpot CRM feedback submissions using a text query, filter groups, sorting, and pagination. Returned properties are limited to the fields represented in the response model.

Input Parameters

string
A pagination token from a previous response to retrieve the next page of results. Omit for the first page.
integer
The maximum number of feedback submissions to return in a single response. Defaults to 10.
string
A string to search across all searchable properties of feedback submissions. This performs a broad text search.
array
A list of property names to sort the results by. Properties are sorted in ascending order by default. Prefix a property name with a hyphen (-) for descending order. Defaults to creation order (oldest first) if omitted.
array
A list of specific feedback submission property names to be included in the response. If omitted, returns default properties: hs_createdate, hs_lastmodifieddate, and hs_object_id.
array
A list of filter groups to apply to the search. Each group represents a set of AND-ed filters. Multiple filter groups are combined using OR logic. Maximum 5 groups with up to 6 filters each (18 total filters maximum).

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: HUBSPOT_SEARCH_FILESBrowses or filters visible HubSpot file-manager records.

Input Parameters

string
Substring to match in file names.
string
File-manager path to match.
string
Exact file size in bytes, represented as a numeric string.
array
Provider file fields to sort by, sent as repeated query values.
string
Forward result offset from a previous response’s paging.next.after value.
integer
Number of files to return, from 1 through 100.
integer
Exact image or video width in pixels.
integer
Exact image or video height in pixels.
string
Minimum HubSpot file ID, represented as a numeric string.
string
Maximum HubSpot file ID, represented as a numeric string.
string
File encoding to match.
array
Numeric file IDs to include, sent as repeated query values.
string
Exact MD5 hash to match.
string
Exact hosted file URL to match.
string
Minimum file size in bytes, represented as a numeric string.
string
Maximum file size in bytes, represented as a numeric string.
string
File extension to match, such as pdf or jpg.
string ("IMG" | "DOCUMENT" | "AUDIO" | "MOVIE" | "OTHER")
HubSpot file type to match.
integer
Minimum image or video width in pixels.
integer
Maximum image or video width in pixels.
string
Return files created at this exact ISO 8601 date and time.
string
Return files expiring at this exact ISO 8601 date and time.
integer
Minimum image or video height in pixels.
integer
Maximum image or video height in pixels.
array
File properties to include in each result, sent as repeated query values.
string
Return files updated at this exact ISO 8601 date and time.
string
Return files created at or after this ISO 8601 date and time.
string
Return files created at or before this ISO 8601 date and time.
string
Return files expiring at or after this ISO 8601 date and time.
string
Return files expiring at or before this ISO 8601 date and time.
string
Return files updated at or after this ISO 8601 date and time.
string
Return files updated at or before this ISO 8601 date and time.
string
Return files updated before this Unix epoch timestamp in milliseconds.
array
Numeric parent folder IDs to include, sent as repeated query values.
boolean
Filter by whether a file can be used in new HubSpot content.
boolean
True for publicly accessible files or false for private files.

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: HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIASearches HubSpot line items using criteria including filters, sorting, and pagination; after must be a valid cursor from a previous response, and sorts/properties must refer to valid line item property names.

Input Parameters

string
Pagination cursor from a prior response to fetch the next page of results. Leave empty for the first page.
integer
Maximum number of line items to retrieve per page (default: 10, max: 200).
string
Optional search string applied across all searchable line item properties.
array
List of property names for sorting results. Prepend ’-’ for descending order. Defaults to creation date ascending if omitted.
array
Specific line item property names to include in results. If omitted or empty, a default set of properties is returned.
array
List of filter groups. Line items must match all filters in at least one group (filters within a group are ANDed; groups are ORed). Leave empty to return all line items.

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: HUBSPOT_SEARCH_PRODUCTSSearches for HubSpot products using flexible criteria and filters.

Input Parameters

string
The cursor for pagination. To get the next page of results, use the after value from the paging.next.after property of a previous response.
integer
The maximum number of products to return in the search results.
string
A string to search across all default text properties of products. Finds records where any of these properties contain the specified string.
array
A list of sort objects to define the order of search results. Each object specifies a propertyName and a direction. For example, [{'propertyName': 'name', 'direction': 'ASCENDING'}] sorts products by name alphabetically.
array
A list of product properties to include in the response. Supports both standard properties and custom properties. If not provided, a default set of properties will be returned.
array
Groups of filters to apply to the ticket search.
array
A list of filter groups to apply to the search. Each filter group contains one or more filters. Filters within a group are combined using AND logic, while multiple filter groups are combined using OR logic. For example: [{'filters': [{'propertyName': 'price', 'operator': 'GT', 'value': '100'}]}].
array
A list of internal names of custom product properties to include in the response. It’s important to use the property’s internal API name. For example ['custom_field_api_name_1', 'custom_field_api_name_2'].

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: HUBSPOT_SEARCH_QUOTES_BY_CRITERIASearches HubSpot CRM quotes using a text query, complex filter criteria, sorting, and pagination.

Input Parameters

string
A cursor for pagination. Set this to the ‘paging.next.after’ value from a previous response to get the next page of results. If not provided, the first page is returned.
integer
The maximum number of quote records to return in the response. Default is 10, maximum is 200.
string
A string to search across all searchable properties of quotes. This performs a broad text search.
array
A list of sort rules to order the results. Only one sort rule can be applied. Each sort contains ‘propertyName’ and ‘direction’ (‘ASCENDING’ or ‘DESCENDING’). If omitted, results are ordered by creation date (oldest first).
array
Specific quote property internal names to include in the response. If omitted, a default set of properties is returned. Include custom property names here.
array
A list of filter groups to apply to the search. Multiple filter groups are combined with an OR logic, while filters within a group are combined with AND logic. Maximum 5 filter groups with up to 6 filters each.

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: HUBSPOT_SEARCH_TICKETSSearches for HubSpot tickets using flexible criteria and filters.

Input Parameters

string
Cursor token for pagination to get the next page of results.
integer
Maximum number of tickets to return in the response.
string
Text search query to find tickets by content or subject.
array
List of sort criteria for ordering the results.
array
Ticket properties to include in the response. Supports both standard and custom properties.
array
Groups of filters to apply to the ticket search.
array
List of custom property names to include 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: HUBSPOT_SET_CALL_RECORDING_SETTINGSConfigures the URL (urlToRetrieveAuthedRecording) that HubSpot uses to retrieve call recordings for a specified third-party calling app (appId). The URL must contain a %s placeholder which HubSpot replaces with the engagement’s externalId. The calling app must be an existing calling extension app integrated with the HubSpot account.

Input Parameters

integer
required
Unique identifier for the third-party calling app integration in HubSpot CRM whose recording settings will be modified.
string
required
Endpoint URL for HubSpot to retrieve call recordings; must contain %s placeholder which HubSpot will replace with the engagement’s externalId, and must serve recordings with authentication if required.

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: HUBSPOT_START_IMPORTStarts an asynchronous HubSpot CRM import using one uploaded file and an import configuration JSON mapping its columns to HubSpot properties.

Input Parameters

object
The binary content of the file(s) to be imported. Supported formats typically include CSV, XLSX, and XLS. Ensure the file structure aligns with the mappings defined in importRequest.
string
A JSON string specifying the configuration for the import process. This configuration dictates how data from the uploaded file(s) is mapped and imported into HubSpot. Key properties include name (a descriptive name for the import, e.g., “Q3 Contact Import”), dateFormat (e.g., ‘MONTH_DAY_YEAR’, ‘DAY_MONTH_YEAR’), importOperations (defines if the import should create and update, only create, or only update records, e.g., ‘CREATE_AND_UPDATE’), and files (an array detailing each file, its format, and columnMappings). The columnMappings are crucial as they map spreadsheet columns to HubSpot CRM object properties (e.g., map ‘Email Address’ column to ‘CONTACT’ object’s ‘email’ property).

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: HUBSPOT_UPDATE_A_MARKETING_EMAILUpdates properties of an existing marketing email identified by its emailId; unspecified fields retain their current values.

Input Parameters

string
The internal name of the email as it appears in the HubSpot dashboard.
string ("AUTOMATED" | "AUTOMATED_DRAFT" | "AUTOMATED_SENDING" | "AUTOMATED_FOR_FORM" | "AUTOMATED_FOR_FORM_BUFFER" | "AUTOMATED_FOR_FORM_DRAFT" | "AUTOMATED_FOR_FORM_LEGACY" | "BLOG_EMAIL_DRAFT" | "BLOG_EMAIL_PUBLISHED" | "DRAFT" | "DRAFT_AB" | "DRAFT_AB_VARIANT" | "ERROR" | "LOSER_AB_VARIANT" | "PAGE_STUB" | "PRE_PROCESSING" | "PROCESSING" | "PUBLISHED" | "PUBLISHED_AB" | "PUBLISHED_AB_VARIANT" | "PUBLISHED_OR_SCHEDULED" | "RSS_TO_EMAIL_DRAFT" | "RSS_TO_EMAIL_PUBLISHED" | "SCHEDULED" | "SCHEDULED_AB" | "SCHEDULED_OR_PUBLISHED" | "AUTOMATED_AB" | "AUTOMATED_AB_VARIANT" | "AUTOMATED_DRAFT_AB" | "AUTOMATED_DRAFT_ABVARIANT" | "AUTOMATED_LOSER_ABVARIANT")
The desired state of the email after the update. Common states include ‘DRAFT’, ‘SCHEDULED’, ‘PUBLISHED’.
string
required
The unique ID of the marketing email to be updated.
string
The subject line of the marketing email.
boolean
Set to true to archive the marketing email, or false to make it active (unarchive).
string
The ID of the HubSpot campaign this email is associated with.
string ("af" | "af-na" | "af-za" | "agq" | "agq-cm" | "ak" | "ak-gh" | "am" | "am-et" | "ar" | "ar-001" | "ar-ae" | "ar-bh" | "ar-dj" | "ar-dz" | "ar-eg" | "ar-eh" | "ar-er" | "ar-il" | "ar-iq" | "ar-jo" | "ar-km" | "ar-kw" | "ar-lb" | "ar-ly" | "ar-ma" | "ar-mr" | "ar-om" | "ar-ps" | "ar-qa" | "ar-sa" | "ar-sd" | "ar-so" | "ar-ss" | "ar-sy" | "ar-td" | "ar-tn" | "ar-ye" | "as" | "as-in" | "asa" | "asa-tz" | "ast" | "ast-es" | "az" | "az-az" | "bas" | "bas-cm" | "be" | "be-by" | "bem" | "bem-zm" | "bez" | "bez-tz" | "bg" | "bg-bg" | "bm" | "bm-ml" | "bn" | "bn-bd" | "bn-in" | "bo" | "bo-cn" | "bo-in" | "br" | "br-fr" | "brx" | "brx-in" | "bs" | "bs-ba" | "ca" | "ca-ad" | "ca-es" | "ca-fr" | "ca-it" | "ccp" | "ccp-bd" | "ccp-in" | "ce" | "ce-ru" | "ceb" | "ceb-ph" | "cgg" | "cgg-ug" | "chr" | "chr-us" | "ckb" | "ckb-iq" | "ckb-ir" | "cs" | "cs-cz" | "cu" | "cu-ru" | "cy" | "cy-gb" | "da" | "da-dk" | "da-gl" | "dav" | "dav-ke" | "de" | "de-at" | "de-be" | "de-ch" | "de-de" | "de-gr" | "de-it" | "de-li" | "de-lu" | "dje" | "dje-ne" | "doi" | "doi-in" | "dsb" | "dsb-de" | "dua" | "dua-cm" | "dyo" | "dyo-sn" | "dz" | "dz-bt" | "ebu" | "ebu-ke" | "ee" | "ee-gh" | "ee-tg" | "el" | "el-cy" | "el-gr" | "en" | "en-001" | "en-150" | "en-ae" | "en-ag" | "en-ai" | "en-as" | "en-at" | "en-au" | "en-bb" | "en-be" | "en-bi" | "en-bm" | "en-bs" | "en-bw" | "en-bz" | "en-ca" | "en-cc" | "en-ch" | "en-ck" | "en-cm" | "en-cn" | "en-cx" | "en-cy" | "en-de" | "en-dg" | "en-dk" | "en-dm" | "en-er" | "en-fi" | "en-fj" | "en-fk" | "en-fm" | "en-gb" | "en-gd" | "en-gg" | "en-gh" | "en-gi" | "en-gm" | "en-gu" | "en-gy" | "en-hk" | "en-ie" | "en-il" | "en-im" | "en-in" | "en-io" | "en-je" | "en-jm" | "en-ke" | "en-ki" | "en-kn" | "en-ky" | "en-lc" | "en-lr" | "en-ls" | "en-lu" | "en-mg" | "en-mh" | "en-mo" | "en-mp" | "en-ms" | "en-mt" | "en-mu" | "en-mw" | "en-mx" | "en-my" | "en-na" | "en-nf" | "en-ng" | "en-nl" | "en-nr" | "en-nu" | "en-nz" | "en-pg" | "en-ph" | "en-pk" | "en-pn" | "en-pr" | "en-pw" | "en-rw" | "en-sb" | "en-sc" | "en-sd" | "en-se" | "en-sg" | "en-sh" | "en-si" | "en-sl" | "en-ss" | "en-sx" | "en-sz" | "en-tc" | "en-tk" | "en-to" | "en-tt" | "en-tv" | "en-tz" | "en-ug" | "en-um" | "en-us" | "en-vc" | "en-vg" | "en-vi" | "en-vu" | "en-ws" | "en-za" | "en-zm" | "en-zw" | "eo" | "eo-001" | "es" | "es-419" | "es-ar" | "es-bo" | "es-br" | "es-bz" | "es-cl" | "es-co" | "es-cr" | "es-cu" | "es-do" | "es-ea" | "es-ec" | "es-es" | "es-gq" | "es-gt" | "es-hn" | "es-ic" | "es-mx" | "es-ni" | "es-pa" | "es-pe" | "es-ph" | "es-pr" | "es-py" | "es-sv" | "es-us" | "es-uy" | "es-ve" | "et" | "et-ee" | "eu" | "eu-es" | "ewo" | "ewo-cm" | "fa" | "fa-af" | "fa-ir" | "ff" | "ff-bf" | "ff-cm" | "ff-gh" | "ff-gm" | "ff-gn" | "ff-gw" | "ff-lr" | "ff-mr" | "ff-ne" | "ff-ng" | "ff-sl" | "ff-sn" | "fi" | "fi-fi" | "fil" | "fil-ph" | "fo" | "fo-dk" | "fo-fo" | "fr" | "fr-be" | "fr-bf" | "fr-bi" | "fr-bj" | "fr-bl" | "fr-ca" | "fr-cd" | "fr-cf" | "fr-cg" | "fr-ch" | "fr-ci" | "fr-cm" | "fr-dj" | "fr-dz" | "fr-fr" | "fr-ga" | "fr-gf" | "fr-gn" | "fr-gp" | "fr-gq" | "fr-ht" | "fr-km" | "fr-lu" | "fr-ma" | "fr-mc" | "fr-mf" | "fr-mg" | "fr-ml" | "fr-mq" | "fr-mr" | "fr-mu" | "fr-nc" | "fr-ne" | "fr-pf" | "fr-pm" | "fr-re" | "fr-rw" | "fr-sc" | "fr-sn" | "fr-sy" | "fr-td" | "fr-tg" | "fr-tn" | "fr-vu" | "fr-wf" | "fr-yt" | "fur" | "fur-it" | "fy" | "fy-nl" | "ga" | "ga-gb" | "ga-ie" | "gd" | "gd-gb" | "gl" | "gl-es" | "gsw" | "gsw-ch" | "gsw-fr" | "gsw-li" | "gu" | "gu-in" | "guz" | "guz-ke" | "gv" | "gv-im" | "ha" | "ha-gh" | "ha-ne" | "ha-ng" | "haw" | "haw-us" | "he" | "hi" | "hi-in" | "hr" | "hr-ba" | "hr-hr" | "hsb" | "hsb-de" | "hu" | "hu-hu" | "hy" | "hy-am" | "ia" | "ia-001" | "id" | "ig" | "ig-ng" | "ii" | "ii-cn" | "id-id" | "is" | "is-is" | "it" | "it-ch" | "it-it" | "it-sm" | "it-va" | "he-il" | "ja" | "ja-jp" | "jgo" | "jgo-cm" | "yi" | "yi-001" | "jmc" | "jmc-tz" | "jv" | "jv-id" | "ka" | "ka-ge" | "kab" | "kab-dz" | "kam" | "kam-ke" | "kde" | "kde-tz" | "kea" | "kea-cv" | "khq" | "khq-ml" | "ki" | "ki-ke" | "kk" | "kk-kz" | "kkj" | "kkj-cm" | "kl" | "kl-gl" | "kln" | "kln-ke" | "km" | "km-kh" | "kn" | "kn-in" | "ko" | "ko-kp" | "ko-kr" | "kok" | "kok-in" | "ks" | "ks-in" | "ksb" | "ksb-tz" | "ksf" | "ksf-cm" | "ksh" | "ksh-de" | "kw" | "kw-gb" | "ku" | "ku-tr" | "ky" | "ky-kg" | "lag" | "lag-tz" | "lb" | "lb-lu" | "lg" | "lg-ug" | "lkt" | "lkt-us" | "ln" | "ln-ao" | "ln-cd" | "ln-cf" | "ln-cg" | "lo" | "lo-la" | "lrc" | "lrc-iq" | "lrc-ir" | "lt" | "lt-lt" | "lu" | "lu-cd" | "luo" | "luo-ke" | "luy" | "luy-ke" | "lv" | "lv-lv" | "mai" | "mai-in" | "mas" | "mas-ke" | "mas-tz" | "mer" | "mer-ke" | "mfe" | "mfe-mu" | "mg" | "mg-mg" | "mgh" | "mgh-mz" | "mgo" | "mgo-cm" | "mi" | "mi-nz" | "mk" | "mk-mk" | "ml" | "ml-in" | "mn" | "mn-mn" | "mni" | "mni-in" | "mr" | "mr-in" | "ms" | "ms-bn" | "ms-id" | "ms-my" | "ms-sg" | "mt" | "mt-mt" | "mua" | "mua-cm" | "my" | "my-mm" | "mzn" | "mzn-ir" | "naq" | "naq-na" | "nb" | "nb-no" | "nb-sj" | "nd" | "nd-zw" | "nds" | "nds-de" | "nds-nl" | "ne" | "ne-in" | "ne-np" | "nl" | "nl-aw" | "nl-be" | "nl-ch" | "nl-bq" | "nl-cw" | "nl-lu" | "nl-nl" | "nl-sr" | "nl-sx" | "nmg" | "nmg-cm" | "nn" | "nn-no" | "nnh" | "nnh-cm" | "no" | "no-no" | "nus" | "nus-ss" | "nyn" | "nyn-ug" | "om" | "om-et" | "om-ke" | "or" | "or-in" | "os" | "os-ge" | "os-ru" | "pa" | "pa-in" | "pa-pk" | "pcm" | "pcm-ng" | "pl" | "pl-pl" | "prg" | "prg-001" | "ps" | "ps-af" | "ps-pk" | "pt" | "pt-ao" | "pt-br" | "pt-ch" | "pt-cv" | "pt-gq" | "pt-gw" | "pt-lu" | "pt-mo" | "pt-mz" | "pt-pt" | "pt-st" | "pt-tl" | "qu" | "qu-bo" | "qu-ec" | "qu-pe" | "rm" | "rm-ch" | "rn" | "rn-bi" | "ro" | "ro-md" | "ro-ro" | "rof" | "rof-tz" | "ru" | "ru-by" | "ru-kg" | "ru-kz" | "ru-md" | "ru-ru" | "ru-ua" | "rw" | "rw-rw" | "rwk" | "rwk-tz" | "sa" | "sa-in" | "sah" | "sah-ru" | "saq" | "saq-ke" | "sat" | "sat-in" | "sbp" | "sbp-tz" | "sd" | "sd-in" | "sd-pk" | "se" | "se-fi" | "se-no" | "se-se" | "seh" | "seh-mz" | "ses" | "ses-ml" | "sg" | "sg-cf" | "shi" | "shi-ma" | "si" | "si-lk" | "sk" | "sk-sk" | "sl" | "sl-si" | "smn" | "smn-fi" | "sn" | "sn-zw" | "so" | "so-dj" | "so-et" | "so-ke" | "so-so" | "sq" | "sq-al" | "sq-mk" | "sq-xk" | "sr" | "sr-ba" | "sr-cs" | "sr-me" | "sr-rs" | "sr-xk" | "su" | "su-id" | "sv" | "sv-ax" | "sv-fi" | "sv-se" | "sw" | "sw-cd" | "sw-ke" | "sw-tz" | "sw-ug" | "sy" | "ta" | "ta-in" | "ta-lk" | "ta-my" | "ta-sg" | "te" | "te-in" | "teo" | "teo-ke" | "teo-ug" | "tg" | "tg-tj" | "th" | "th-th" | "ti" | "ti-er" | "ti-et" | "tk" | "tk-tm" | "tl" | "to" | "to-to" | "tr" | "tr-cy" | "tr-tr" | "tt" | "tt-ru" | "twq" | "twq-ne" | "tzm" | "tzm-ma" | "ug" | "ug-cn" | "uk" | "uk-ua" | "ur" | "ur-in" | "ur-pk" | "uz" | "uz-af" | "uz-uz" | "vai" | "vai-lr" | "vi" | "vi-vn" | "vo" | "vo-001" | "vun" | "vun-tz" | "wae" | "wae-ch" | "wo" | "wo-sn" | "xh" | "xh-za" | "xog" | "xog-ug" | "yav" | "yav-cm" | "yo" | "yo-bj" | "yo-ng" | "yue" | "yue-cn" | "yue-hk" | "zgh" | "zgh-ma" | "zh" | "zh-cn" | "zh-hk" | "zh-mo" | "zh-sg" | "zh-tw" | "zh-hans" | "zh-hant" | "zu" | "zu-za")
The primary language of the email, using ISO 639-1 language codes (e.g., ‘en’) or language-locale codes (e.g., ‘en-us’).
string
The scheduled publication date and time for the email in ISO 8601 format (e.g., ‘2023-12-31T10:00:00Z’). Used for scheduled emails.
string
The subcategory of the email, often used for organization (e.g., ‘newsletter’, ‘promotional’).
string
The domain from which this email will be sent (e.g., ‘info.example.com’). Must be a connected sending domain in HubSpot.
string
The URL of the external RSS feed if not using a HubSpot blog.
string
The email address used as the ‘From’ address and default ‘Reply-To’ address. Must be a verified address in HubSpot.
boolean
If true and the email state is set to ‘PUBLISHED’, the email will be sent immediately. If false for a ‘PUBLISHED’ state, it implies it was already sent or is a template.
string
The ID of the business unit this email belongs to. Requires the Business Units add-on for HubSpot.
string
The sender’s name as it appears in the recipient’s inbox (e.g., ‘Marketing Team’).
object
A dictionary defining the scheduling for RSS emails (e.g., time of day, day of week/month). The structure depends on blogEmailType.
string
The unique identifier of the A/B test, if applicable.
object
A dictionary specifying the configuration and content of various widgets (modules) used in the email.
string
The URL slug for the web version of the email (e.g., ‘july-newsletter-2024’).
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Status of the AB test (e.g., ‘master’, ‘variant’).
string
The title displayed in the browser tab for the web version of the email.
object
A dictionary defining content for flexible column areas within drag-and-drop email templates.
string
The domain to be used for the web version of this email. If not specified, the default portal domain is used.
string
A custom email address for replies. If set, this overrides the main replyTo address for replies.
string
Defines the layout style for displaying blog posts within an RSS email.
integer
The maximum number of blog posts to include in a single RSS email.
object
A dictionary of smart fields and their values/configurations used in the email content. Enables personalization based on contact properties.
integer
Time limit in hours on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
boolean
If true, HubSpot will attempt to avoid sending this email to contacts classified as ‘graymail’ (low engagement).
string
The path to the email template file within the HubSpot Design Manager (e.g., ‘marketplace/some_template_name’).
string
The date and time when the web version link will expire, in ISO 8601 format. After this time, the link may redirect or show an error.
string
Specifies the type of RSS email, such as instant, daily, weekly, or monthly.
string
The ID of the HubSpot blog used as the source for an RSS-to-email.
boolean
If true, respects HubSpot’s send frequency limits for contacts. If false, may override these limits.
array
A list of contact IDs to specifically exclude from receiving this email.
array
A list of contact IDs to specifically include as recipients for this email.
string ("CLICKS_BY_OPENS" | "CLICKS_BY_DELIVERED" | "OPENS_BY_DELIVERED")
Metric to determine the winning version that will be sent to the remaining contacts (e.g., ‘CLICKS_BY_OPENS’).
string
The plain text version of the email. If omitted, HubSpot may auto-generate it from the HTML content.
object
A dictionary defining the layout and content of widget containers in the email template.
string
The HTML template used to render each individual blog post (entry) in an RSS email.
integer
The percentage of recipients who will be part of the A/B test group (e.g., 50 for 50%).
array
A list of contact list IDs whose members should be excluded from receiving this email.
array
A list of contact list IDs whose members should receive this email.
string
An external URL to redirect to if the web version link is expired or disabled, used if redirectToPageId is not set.
integer
Maximum width in pixels for images included from an RSS feed in the email.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Version of the email that should be sent if the results are inconclusive after the test period (e.g., ‘master’, ‘variant’).
string
The meta description for the web version of the email, used by search engines.
object
A dictionary of theme settings overrides for the email template. Allows customization of global theme styles.
string ("master" | "variant" | "loser_variant" | "mab_master" | "mab_variant" | "automated_master" | "automated_variant" | "automated_loser_variant")
Version of the email that should be sent if there are too few recipients to conduct an AB test (e.g., ‘master’, ‘variant’).
string
The ID of a HubSpot-hosted page to redirect to if the web version link is expired or manually disabled.
boolean
If true, the headline of the latest blog post will be used as the email’s subject line for RSS emails.
string
The ID of the specific email subscription type (e.g., marketing, newsletter) this email belongs to.
string
The ID of the CAN-SPAM office location to be used in the email footer.
string
The ID of the subscription preferences page/group associated with this email. Allows recipients to manage their preferences.

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: HUBSPOT_UPDATE_BATCH_FEEDBACK_SUBMISSIONSUpdates a batch of HubSpot feedback submissions; property keys must be existing internal HubSpot names and values must be correctly formatted strings.

Input Parameters

array
required
List of feedback submissions to update, each specifying its identifier and new property values.

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: HUBSPOT_UPDATE_BATCH_OF_OBJECTS_BY_IDOR_PROPERTY_VALUESPerforms a batch update on a valid objectType where properties are writeable and any idProperty used is designated unique; updates can be partial.

Input Parameters

array
required
List of objects to update, each detailing the object and its property changes. Max 100 objects per batch.
string
required
Case-sensitive CRM object type to be updated in bulk (e.g., ‘contacts’, ‘p_customobject’), determining the target object set.

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: HUBSPOT_UPDATE_CALLING_APP_RECORDING_SETTINGSUpdates the recording settings, such as the URL for retrieving authenticated recordings, for a specific calling extension app identified by its appId.

Input Parameters

integer
required
The unique identifier for the calling app.
string
URL HubSpot uses to retrieve call recordings requiring authentication from the calling app.

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: HUBSPOT_UPDATE_CALLING_EXTENSION_SETTINGSUpdates settings (e.g., display name, UI URL/dimensions, feature flags) for an existing calling extension app, identified by appId.

Input Parameters

string
URL to the phone/calling UI, which should be built using the HubSpot Calling SDK.
string
User-facing display name of the calling service.
integer
required
The unique ID of the target app whose calling extension settings are being modified.
integer
Target width (pixels) of the iframe embedding the phone/calling UI.
integer
Target height (pixels) of the iframe embedding the phone/calling UI.
boolean
If true, the calling service appears as an option under the ‘Call’ action in contact records.
boolean
Indicates if the calling service is compatible with HubSpot’s engagement V2 service and custom objects.

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: HUBSPOT_UPDATE_CAMPAIGNPartially updates specific, writable properties of an existing HubSpot marketing campaign identified by campaignGuid; an empty string value in properties clears a property.

Input Parameters

object
required
Dictionary of campaign properties to update. Keys are internal property names (e.g., hs_name, hs_campaign_status, hs_start_date), values are their new string values. Values overwrite existing ones. Attempting to update read-only or non-existent properties will result in an error. To clear a property, set it to an empty string.
string
required
Unique identifier (UUID) of the HubSpot marketing campaign to update.

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: HUBSPOT_UPDATE_CAMPAIGNSUpdates properties for up to 50 existing HubSpot marketing campaigns in a single batch operation.

Input Parameters

array
required
A list of campaign objects to update. Each object must include the campaign ‘id’ and a ‘properties’ dictionary.

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: HUBSPOT_UPDATE_COMPANIESUpdates multiple HubSpot companies in a single batch operation.

Input Parameters

array
required
List of company update operations, each specifying company ‘id’ and ‘properties’ with new values.

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: HUBSPOT_UPDATE_COMPANYUpdates properties for an existing HubSpot company.

Input Parameters

string
required
Unique HubSpot identifier for the company to be updated. Can be provided as a string or number.
object
required
Company properties to update. Keys are internal HubSpot property names; use an empty string to clear a property. Common properties and their expected formats: ‘name’ (string), ‘domain’ (string, e.g., ‘example.com’), ‘phone’ (string), ‘website’ (URL string), ‘industry’ (enum - must use HubSpot’s predefined SCREAMING_SNAKE_CASE values, e.g., COMPUTER_SOFTWARE, FINANCIAL_SERVICES, HOSPITAL_HEALTH_CARE, RETAIL, BIOTECHNOLOGY; see HubSpot docs for the full list), ‘annualrevenue’ (numeric string only, e.g., ‘150000000’ - do NOT include currency symbols, words, or text), ‘numberofemployees’ (numeric string, e.g., ‘500’), ‘description’ (string), ‘city’ (string), ‘state’ (string), ‘country’ (string), ‘zip’ (string). Read-only properties are ignored.

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: HUBSPOT_UPDATE_CONTACTUpdates properties for an existing HubSpot contact. Known read-only properties are filtered out; if no properties remain, the current contact is returned without an update.

Input Parameters

string
required
Unique HubSpot identifier for the contact to be partially updated. Can also be provided as ‘contact_id’ (snake_case).
object
Standard HubSpot contact properties. Use these for common contact fields.
object
Custom HubSpot properties to update. Use this for any custom properties you’ve created in your HubSpot account. Keys must be the internal property names (e.g., ‘my_custom_field’). Values must be strings. Use HUBSPOT_LIST_CONTACT_PROPERTIES with custom_only=true to discover available custom property names. These are merged with standard properties before sending to the API.

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: HUBSPOT_UPDATE_CONTACTSUpdates multiple HubSpot contacts in a single batch operation.

Input Parameters

array
required
List of contact update operations, each specifying contact ‘id’ (VID) and ‘properties’ with new values.

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: HUBSPOT_UPDATE_CRM_PROPERTYUpdates attributes of an existing HubSpot CRM property, identified by its objectType and propertyName; only provided fields are modified, and changing a property’s type can cause data loss if incompatible with existing data.

Input Parameters

string ("string" | "number" | "date" | "datetime" | "enumeration" | "bool")
New data type for the property. Modifying the type of an existing property with data can cause data loss; use with caution.
string
New human-readable label for the property, displayed in the HubSpot UI.
boolean
If true, hides the property in the HubSpot UI, making it not generally visible or usable in standard interfaces.
array
List of new option definitions if property type is ‘enumeration’; supplying a new list overwrites existing options.
string ("textarea" | "text" | "date" | "file" | "number" | "select" | "radio" | "checkbox" | "booleancheckbox" | "calculation_equation")
New field type controlling how the property is displayed and interacted with in the HubSpot UI.
boolean
If true, allows this property to be included as a field in HubSpot forms and available in the form editor.
string
New internal name of the property group for this property; groups help organize properties in the HubSpot UI.
string
required
Type of CRM object for which the property is being updated; this determines its context.
string
New description for the property, displayed as help text in the HubSpot UI.
integer
New display order for the property within its group. Lower positive integers appear first; -1 typically places it after positively numbered properties.
string
required
Internal name of the property to update (case-sensitive); must correspond to an existing property for the specified objectType.
string
New formula if fieldType is ‘calculation_equation’; defines how its value is auto-computed. Ensure valid HubSpot calculation syntax.

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: HUBSPOT_UPDATE_DEALUpdates properties for an existing HubSpot deal.

Input Parameters

string
required
Unique HubSpot identifier for the deal to be updated.
object
required
Deal properties to update. Must contain at least one property. Keys are internal HubSpot property names; use empty string to clear a property. IMPORTANT - Some properties require specific internal HubSpot IDs: (1) ‘dealstage’ and ‘pipeline’ require internal IDs (not human-readable labels). (2) ‘hubspot_owner_id’ requires a valid HubSpot user/owner ID. Common text/numeric properties: dealname (string), amount (decimal string), closedate (YYYY-MM-DD or ISO 8601), description (string), deal_currency_code (3-letter currency code like ‘USD’). Enum/select properties have case-sensitive values - use exact values as defined in HubSpot. Use HUBSPOT_READ_A_CRM_PROPERTY_BY_NAME to retrieve valid enum options for any property.

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: HUBSPOT_UPDATE_DEALSUpdates multiple HubSpot deals in a single batch operation.

Input Parameters

array
required
List of deal update operations.

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: HUBSPOT_UPDATE_EMAILPartially updates properties of an existing HubSpot email object, identified by emailId (as internal ID or custom unique property value if idProperty is given); the object must exist.

Input Parameters

string
required
Identifier of the email object. This is its internal HubSpot ID, or a custom unique property value if idProperty is also provided.
string
Name of a unique HubSpot property for emails. If specified, emailId must be the value of this unique property, not the internal HubSpot ID.
object
required
Property names and new values for the email. Values overwrite existing ones; an empty string clears a property. Read-only or non-existent properties are ignored.

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: HUBSPOT_UPDATE_EMAILSUpdates multiple HubSpot CRM email engagement records by ID in a single batch operation.

Input Parameters

array
required
List of email update operations.

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: HUBSPOT_UPDATE_EMAIL_SUBSCRIPTIONSIRREVERSIBLY opt out or update email subscription preferences in HubSpot.

Input Parameters

string
required
Email address whose preferences will be updated. Also provide at least one effective update field.
boolean
Permanently opt the address out from all email. This cannot be undone. At least one of this field, subscription_statuses, or portal_subscription_legal_basis is required.
array
One or more subscription type updates. Opting out from a type cannot be undone. At least one of this field, unsubscribe_from_all, or portal_subscription_legal_basis is required.
Portal-level GDPR legal basis. At least one of this field, unsubscribe_from_all, or subscription_statuses is required.
Explanation supporting the portal-level legal basis; requires portal_subscription_legal_basis.

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: HUBSPOT_UPDATE_EVENT_TEMPLATEUpdates an existing HubSpot event template’s name, display templates, and tokens; providing tokens replaces the entire existing list, and the id in the request body must match eventTemplateId in the path.

Input Parameters

string
required
Unique identifier of the event template; must match eventTemplateId in the URL path.
string
required
New name for the event template.
integer
required
ID of the application associated with the event template.
array
required
List of token definitions; replaces all existing tokens for the template.
string
Markdown for the event’s detailed timeline view, using Handlebars for dynamic data (e.g., {{token_name}}).
string
Markdown for the event’s header on the timeline, using Handlebars for dynamic data (e.g., {{token_name}}).
string
required
Unique identifier of the event template to update.

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: HUBSPOT_UPDATE_FEEDBACK_SUBMISSIONPartially updates writable properties of an existing HubSpot Feedback Submission, identified by its feedbackSubmissionId (which can be an internal object ID, or a unique property value if idProperty is specified).

Input Parameters

string
The name of a unique property used to identify the Feedback Submission. If provided, feedbackSubmissionId must contain the value of this property, instead of the internal object ID. This property must be a unique identifier for Feedback Submission objects.
object
required
A dictionary of properties to update on the Feedback Submission. Keys are the internal names of the properties, and values are their new string values. Only properties included here will be modified; others will remain unchanged.
string
required
The unique identifier of the Feedback Submission to update. This can be its internal object ID or a unique property value if idProperty is specified. Must be a non-empty string.

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: HUBSPOT_UPDATE_LANDING_PAGESparse-update a HubSpot landing page and return its updated state.

Input Parameters

string
New internal page name.
string
New URL path segment.
string
Connected page domain.
string
required
Unique HubSpot landing-page ID.
boolean
Whether the target is archived.
string
Custom head HTML.
string
Browser and search title.
Custom footer HTML.
string
Design Manager template path.
string
SEO metadata description.
object
Other documented Page fields using exact HubSpot wire names.

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: HUBSPOT_UPDATE_LANDING_PAGE_DRAFTPartially update a HubSpot landing page draft without publishing it.

Input Parameters

string
required
Unique HubSpot ID of the landing page draft to update.
object
required
Sparse object exposing common writable HubSpot Page fields with typed snake_case names. Omitted fields remain unchanged and explicit null values are preserved for nullable fields. Additional expert or provider-added fields are forwarded unchanged using their exact HubSpot names.

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: HUBSPOT_UPDATE_LINE_ITEMPartially updates specified properties of an existing HubSpot Line Item, identified by lineItemId (as HubSpot object ID or value of idProperty if used); new values overwrite existing ones, and an empty string clears a property.

Input Parameters

string
Name of a unique property on the Line Item used for identification instead of HubSpot object ID. If used, lineItemId must contain this property’s value. Must be a valid, unique-value property for Line Items.
string
required
Identifier for the Line Item to update: HubSpot object ID by default, or the value of the unique property if idProperty is specified. Must be non-empty.
object
required
Properties to update. Keys are internal HubSpot line item property names (e.g., ‘quantity’, ‘price’), values are new string values. Example: {'quantity': '5', 'name': 'New Product Name'}.

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: HUBSPOT_UPDATE_LINE_ITEMSUpdates a batch of existing HubSpot CRM line items in a single operation, identifying each by its primary ID or a unique idProperty (which must be a unique identifier property in HubSpot), and modifies their specified properties.

Input Parameters

array
required
A list of objects, where each object defines a line item to be updated and its new property values. Each object must conform to the InputsRequest schema.

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: HUBSPOT_UPDATE_LIST_FILTERSReplace dynamic-list filters and optionally enroll newly matching records.

Input Parameters

string
required
ILS ID of the dynamic list whose filters should be replaced.
object
required
Complete replacement filter branch using exact HubSpot wire keys and its polymorphic OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS, or ASSOCIATION grammar.
boolean
Whether records newly added by the filter change should be enrolled in relevant workflows.

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: HUBSPOT_UPDATE_LIST_MEMBERSHIPSAdds records to or removes records from a manual or snapshot CRM list.

Input Parameters

string
required
Unique ID of the manual or snapshot list to update.
string ("add" | "remove")
required
Membership operation to perform: add records or remove records.
array
required
One or more CRM record IDs to add to or remove from the list.

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: HUBSPOT_UPDATE_OBJECT_SCHEMAUpdates an existing custom object schema’s metadata in HubSpot, such as its description, labels, display properties, required properties, searchable properties, and restorability, for a specified objectType that must already exist.

Input Parameters

string
required
The fully qualified name or object type ID that uniquely identifies the custom object schema to be updated. This must correspond to an existing schema in your HubSpot account.
boolean
A boolean indicating whether records of this object type can be restored from the recycle bin if deleted. Set to true to enable restoration, false otherwise.
string
A human-readable description for the custom object schema itself.
string
The plural display name for the custom object type (e.g., ‘Companies’, ‘Tickets’), used in the HubSpot UI for multiple records of this type.
string
The singular display name for the custom object type (e.g., ‘Company’, ‘Ticket’), used in the HubSpot UI for a single record of this type.
array
A list of internal names of properties that are mandatory when creating a new record of this object type.
array
A list of internal names of properties that will be indexed and searchable within HubSpot’s product search for this object type.
string
The internal name of the property that will serve as the primary display identifier on the HubSpot record page for this object type. This is typically a unique identifier like a name or ID.
array
A list of internal names of properties to be displayed as secondary information on the HubSpot record page for this object type. These properties appear below the primary display property.

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: HUBSPOT_UPDATE_PIPELINEPartially updates a CRM pipeline’s label, display order, or restores an archived pipeline by setting archived to false.

Input Parameters

string
Unique label for the pipeline for UI organization.
boolean
To restore an archived pipeline, set to false. Other uses (e.g., archiving an active pipeline or setting false for an already active one) will result in a 400 Bad Request.
string
required
Type of CRM object the pipeline is associated with (e.g., ‘deals’, ‘tickets’).
string
required
Unique identifier of the pipeline to update.
integer
Display order for the pipeline. Pipelines with the same order are sorted alphabetically by label.
boolean
If true, verify existing references to pipeline stages before updates that could delete or alter them.
boolean
For deal pipelines only: if true, check if any deals use stages affected by the update.

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: HUBSPOT_UPDATE_PIPELINE_STAGEPartially updates a HubSpot CRM pipeline stage identified by object type, pipeline ID, and stage ID. Metadata can be supplied along with other stage fields.

Input Parameters

string
The display name (label) of the pipeline stage. This label must be unique within the pipeline it belongs to. Omit to leave unchanged.
string
required
Unique identifier of the pipeline stage to update; must exist within the specified pipelineId.
boolean
Set to true to archive the pipeline stage, false to unarchive. If omitted, its archival status remains unchanged.
object
Stage-specific metadata (key-value string pairs) based on objectType. Omit to leave unchanged. - For ‘deals’: If provided, MUST include ‘probability’ (string ‘0.0’-‘1.0’, e.g., ‘0.7’, in ‘0.1’ increments). - For ‘tickets’: Optional ‘ticketState’ (‘OPEN’ or ‘CLOSED’). - For other object types, an empty {} may be used.
string
required
Type of CRM object (e.g., ‘deals’, ‘tickets’) for the pipeline; must be a valid HubSpot object type that supports pipelines.
string
required
Unique identifier of the pipeline (specific to the HubSpot account and objectType) containing the stage to update; must refer to an existing pipeline.
integer
The display order for this pipeline stage. If multiple stages share the same displayOrder, they are sorted alphabetically by label. Lower numbers appear first. Omit to leave unchanged.

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: HUBSPOT_UPDATE_PRODUCTUpdates properties for an existing HubSpot product.

Input Parameters

string
required
Unique HubSpot identifier for the product to be updated.
object
required
Product properties to update. Keys are internal HubSpot property names.

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: HUBSPOT_UPDATE_PRODUCTSUpdates multiple HubSpot products in a single batch operation.

Input Parameters

array
required
List of product update operations.

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: HUBSPOT_UPDATE_PROPERTY_GROUPPartially updates a property group’s displayOrder or label for a specified CRM objectType in HubSpot.

Input Parameters

string
Human-readable label for the property group in the UI. If omitted, the current label is unchanged.
string
required
The unique, case-sensitive internal name of the existing property group to be updated for the specified objectType.
string
required
The CRM object type (e.g., “contacts”, “companies”) for which the property group is updated; must be a valid HubSpot CRM object type.
integer
Order for displaying the property group: lowest positive integer first, -1 places it after positive values. If omitted, the current order is unchanged.

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: HUBSPOT_UPDATE_QUOTEPerforms a partial update on an existing HubSpot quote’s specified properties, identifying the quote by quoteId (either its internal ID or a custom unique property value if idProperty is provided).

Input Parameters

string
required
Unique identifier of the quote. Typically an internal HubSpot object ID, or a unique property value if idProperty is specified.
string
Optional. Name of a unique quote property. If provided, quoteId is interpreted as this property’s value, not the internal object ID.
object
required
Properties to update on the quote (internal property names to new values). Only included properties will be updated.

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: HUBSPOT_UPDATE_SITE_PAGEPartially update one HubSpot site page without changing omitted properties.

Input Parameters

string
required
Unique HubSpot ID of the site page to update.
object
required
Typed, non-empty site-page patch. Omitted properties remain unchanged; explicit null clears nullable values, and supplied nested objects replace those property values.
boolean
Whether the site page being updated is archived (deleted).

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: HUBSPOT_UPDATE_SITE_PAGE_DRAFTPartially update a site-page draft; supplied nested objects replace in full.

Input Parameters

object
required
Sparse site-page fields to update. Unknown documented or provider-added camelCase fields are accepted. Only supplied top-level fields are changed, but each supplied nested structure fully replaces that provider object; it is not deep-merged. Include every nested value that must be retained.
string
required
Unique HubSpot ID of the site page whose draft to update.

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: HUBSPOT_UPDATE_TICKETUpdates properties for an existing HubSpot ticket.

Input Parameters

string
required
Unique HubSpot identifier for the ticket to be updated.
object
required
Ticket properties to update. Keys are internal HubSpot property names. Values can be strings, numbers, or booleans - they will be automatically converted to strings as required by HubSpot API.

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: HUBSPOT_UPDATE_TICKETSUpdates multiple HubSpot tickets in a single batch operation.

Input Parameters

array
required
List of ticket update operations.

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: HUBSPOT_UPDATE_TOKEN_ON_EVENT_TEMPLATEUpdates an existing token in a HubSpot CRM event template, including its label, options, or CRM object property mapping. The token name and data type remain unchanged.

Input Parameters

integer
required
Unique identifier (ID) of the application associated with the event template and token.
string
required
New human-readable label for the token, displayed in UIs and used for segmentation/reporting.
array
List of option objects defining selectable choices, applicable only if the token’s type is ‘enumeration’. Required to modify options for an enumeration type token.
string
required
Name of the token to update within the specified event template; must match an existing token’s name.
string
required
Unique identifier (ID) of the event template containing the token to update.
string
Name of the CRM object property this token populates, linking its value to a CRM object property. If null, no direct mapping.

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: HUBSPOT_UPDATE_VIDEO_CONFERENCE_APP_SETTINGSUpdates webhook URLs for a specified HubSpot video conference application, including URLs for creating, updating and deleting meetings, fetching accounts, and verifying users.

Input Parameters

integer
required
Unique identifier for the video conference application in HubSpot, assigned upon creation in the developer portal. Example: 12345.
string
URL HubSpot uses to verify a user’s existence and authentication with the video conference app, confirming identity before certain actions.
string
required
URL HubSpot uses to send requests for creating new video conference meetings. Must use HTTPS protocol.
string
URL HubSpot uses to notify the video conference app when an integrated meeting is deleted in HubSpot.
string
URL HubSpot uses to fetch user accounts from the video conference app, enabling users to select from multiple accounts if available.
string
URL HubSpot uses to send updates for existing meetings, e.g., when details like topic or schedule are modified within HubSpot.

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: HUBSPOT_UPDATE_WORKFLOWFully replace an existing Automation v4 workflow at its current revision.

Input Parameters

string
required
ID of the existing HubSpot workflow to replace.
object
required
Complete ApiFlowPutRequest using exact HubSpot camelCase keys. Both workflow variants require type, actions, blockedDates, customProperties, isEnabled, revisionId, and timeWindows. A CONTACT_FLOW also requires canEnrollFromSalesforce and suppressionListIds. Copy only fields represented by this request schema from a fresh workflow read; response-only fields such as id, createdAt, updatedAt, dataSources, flowType, objectTypeId, and nextAvailableActionId are not accepted by the PUT contract.

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: HUBSPOT_UPSERT_COMPANIESCreates or updates as many as 100 HubSpot companies by unique property value.

Input Parameters

array
required
Companies to upsert. Include between 1 and 100 items.

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: HUBSPOT_UPSERT_CONTACTSCreates or updates as many as 100 HubSpot contacts by unique property value.

Input Parameters

array
required
Contacts to upsert. Include between 1 and 100 items. HubSpot does not support partial upserts when an item’s idProperty is email.

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: HUBSPOT_WHO_AM_IReturn the connected HubSpot account (portal id, domain). HubSpot identity is account-level, not per-user.

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

Triggers

Slug: HUBSPOT_CONTACT_CREATED_TRIGGERType: webhookContact Created Trigger

Configuration

string
required
The ID of the app.
string
required
HubSpot Developer API Key (hapikey) for webhook management. Get this from developers.hubspot.com

Payload

string
required
The ID of the object.
string
required
The type of the event subscription.
string
required
The ID of the subscription.
Slug: HUBSPOT_DEAL_STAGE_UPDATED_TRIGGERType: webhookDeal Stage UpdatedTrigger

Configuration

string
required
The ID of the app.
string
required
HubSpot Developer API Key (hapikey) for webhook management. Get this from developers.hubspot.com

Payload

string
required
The ID of the object.
string
required
The type of the event subscription.
string
required
The ID of the subscription.