HubSpot

The unique identifier of the asset to be associated with the campaign. This ID is specific to the `assetType` (e.g., a form ID, list ID, or external URL ID).

Type of asset to associate with the campaign. Supported types: 'FORM', 'OBJECT_LIST' (Static List), 'EXTERNAL_WEB_URL' (External Website Page).

The unique identifier (UUID) of the HubSpot campaign to which the asset will be associated.

A dictionary containing the API response, often detailing the asset's association with the campaign or confirming the success of the operation.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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 (_).

The data type of the token. Determines how the token's value is stored and validated.

Numeric identifier of the target application associated with the event template. Provided in the URL path.

The user-facing label for the token. This label is used for list segmentation and in reporting.

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

The creation date and time of the event template token in ISO 8601 format (e.g., '2023-01-15T10:30:00Z'). This field is nullable and will be null if the template was created before February 18th, 2020.

The date and time the event template token was last updated, in ISO 8601 format (e.g., '2023-01-16T14:45:00Z'). This field is nullable and will be null if the template was updated before February 18th, 2020.

Unique identifier of the event template. Provided in the URL path.

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.

A dictionary containing the full details of the newly created event template token.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Identifier of the email to be archived.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of input objects, each specifying the ID of an email to be archived.

A dictionary containing the results of the batch archive operation. The content may vary, typically providing status information for the archived emails or details of any errors encountered during the process.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Status of the batch archive operation; a 204 No Content response (empty dictionary or success indicator) is typical for success, while partial successes or failures may include detailed statuses for each quote.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of company objects, where each object contains the 'id' of a company to be archived.

A dictionary containing the results of the batch archive operation. If all operations are successful (HTTP 200), this may be empty or provide a success confirmation. In case of partial success or failures (HTTP 207 Multi-Status), it typically includes details on the status of each archival attempt.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

A dictionary containing the response data from the API. Typically, a successful request to this endpoint returns a 204 No Content response if the batch archive was successful, meaning this field might be empty or not present for successful operations. If there are errors, this field may contain details about them.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of deals to archive, each specified by its unique 'id'.

Response data from the batch archive operation. The structure of this dictionary can vary. Note that a fully successful batch archive often results in a 204 No Content HTTP status, meaning no response body is returned and this field may not be populated.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of objects, where each object contains the 'id' of a feedback submission to be archived.

A dictionary containing details of the batch archive request's acceptance. Since the operation is asynchronous, this response typically confirms that the batch archival task has been queued for processing, potentially including a status like 'PENDING' or a job identifier.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of objects, where each object contains the 'id' of a line item to be archived.

A dictionary that may contain results or errors if the API provides a response body. For successful 204 No Content responses, this field is typically absent or the response body is empty.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of input objects, where each object contains the 'id' of a CRM record to be archived.

The type of CRM object to archive (e.g., 'contacts', 'companies', 'deals', 'tickets').

Details from the batch archive operation; may be empty for a successful operation (HTTP 204) or contain individual error/status information.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of properties to archive, each specified by its internal `name`.

The HubSpot CRM object type for which properties are being archived.

Dictionary containing data returned by the batch archive operation; structure and content may vary.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of tickets to archive, each identified by its ID.

Details about the batch archive operation; specific contents may vary but reflect the outcome.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of products to be archived, each specified by its unique 'id'.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The system-generated unique identifier for the company to archive, obtainable from other HubSpot API endpoints.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique HubSpot CRM identifier (typically numeric or UUID) for the contact to be archived.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

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').

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of email objects to be archived.

Response data from the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

A dictionary that may contain data related to the outcome of the archive operation. For successful archive operations (which typically return an HTTP 204 No Content status), this field might be empty or not applicable.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Usually an empty dictionary upon successful archival.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique HubSpot identifier for the product to be archived.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of an existing product in your HubSpot product catalog to be archived.

Response data from the API; typically empty for a successful archival (204 No Content), but may contain details in case of an error.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of product objects to be archived.

Response data from the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The case-sensitive type of CRM object (e.g., 'contacts', 'companies') for which the property is being archived; must match an existing object type.

The case-sensitive internal name of the property to archive (e.g., 'custom_field_1', 'annual_revenue').

Empty dictionary, as the API returns 204 No Content on successful archival.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

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.

Contains API response data; typically empty for a successful archive operation (HTTP 204 No Content response).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique HubSpot identifier for the ticket to be archived.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of an existing HubSpot ticket to be archived.

The response data. For a successful ticket archival (HTTP 204 No Content), this dictionary will typically be empty.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of ticket objects to be archived.

Response data from the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

The unique identifier of an existing pipeline within the specified `objectType` for which to retrieve the audit history.

Details all changes (mutations) to the pipeline in reverse chronological order.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of company identifiers to retrieve. Each `id` within an input object corresponds to the value of the property specified in `idProperty`.

If true, returns only archived company records; otherwise (default), returns active, non-archived companies.

Property name to use as the unique identifier for companies in `inputs`. If not provided, HubSpot's default company ID (`hs_object_id`) is used.

List of company property names to retrieve. If omitted, a default set of properties is returned.

List of company property names for which to retrieve historical values.

Dictionary of batch read results: keys are requested company IDs, values are company objects with their properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of objects, where each object specifies an email to be retrieved. Each object must contain an `id` field identifying the email.

Whether to include archived emails in the results. If `True`, only archived emails are returned; if `False`, archived emails are excluded.

The name of a unique property to be used for identifying the emails specified in the `inputs` list. If omitted, the system defaults to using the HubSpot email ID (`hs_object_id` or `id`). When specified, ensure the `id` values within the `inputs` list correspond to the values of this unique property for the respective emails.

Email property internal names to return for each email; if omitted, default properties are returned. Specifying properties can optimize response size and processing.

Email property internal names for which all historical values should be retrieved; requesting history for many properties can impact performance.

A dictionary where keys are the input identifiers (the `id` from each item in the `inputs` list) and values are the corresponding email objects. Each email object includes the properties specified in the request. If an email ID is not found or an error occurs for a specific email, it might be absent from the results or handled as per HubSpot's batch API error reporting.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Dictionary containing results of the batch update, including status for each quote (e.g., success, failure) and any updated quote information.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by campaign name using a partial substring match. If omitted, no name filtering is applied.

Allowed values: `hs_name`, `createdAt`, `updatedAt`. Prefix field name with `-` for descending order. Defaults to `hs_name` if unspecified.

Pagination cursor to retrieve the next set of results, typically obtained from a previous response's 'paging' object.

Maximum number of campaigns per page. Allowed range: 1-100. Defaults to 50 if unspecified.

List of campaign property names to return. If a property value is empty for a campaign, it is omitted from that campaign's data in the response. An empty list input may result in an empty 'properties' map in the response.

Raw JSON response from the HubSpot API. Typically includes a 'results' list of campaign objects and a 'paging' object for pagination. Campaign objects in 'results' contain the requested properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

A dictionary containing the API response. Typically, this includes a confirmation or status update regarding the cancellation of the import job.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the existing marketing email to be cloned.

The name for the newly cloned marketing email. If not provided, HubSpot may assign a default name (e.g., 'Copy of [Original Email Name]').

A dictionary representing the full object of the newly cloned marketing email, including its new ID, name, content, and other properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Publicly accessible HTTPS URL for the phone/calling UI, which should be built using the HubSpot Calling SDK.

Display name for the calling service in the HubSpot interface.

Unique identifier for the target HubSpot app whose calling extension settings are being configured.

Target width in pixels for the iframe embedding the calling UI.

Target height in pixels for the iframe embedding the calling UI.

If `true`, the calling service appears as an option under the 'Call' action in contact records; `false` hides it.

Specifies if the service is compatible with HubSpot's engagement v2 service and custom objects.

A dictionary containing the updated settings of the configured calling extension, confirming the changes applied.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A dictionary of key-value pairs representing the properties of the email. Essential properties include `hs_email_subject`, `hs_email_html` (for the email body), `hs_timestamp` (UTC millisecond timestamp of when the email was sent or will be sent), and potentially `hubspot_owner_id`, `hs_email_direction`, `hs_email_status`.

A list of associations to link this email with other CRM objects. Each association specifies the target object's ID (`to_id`) and the nature of the relationship (`types`).

A dictionary containing the properties of the newly created email object, including its unique ID (e.g., `id`) and other attributes.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of campaign objects to be created in a batch, each defining a new campaign and its properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of company objects to create, each defining properties and associations. Maximum of 100 companies per batch.

The raw response data from the API detailing the outcome of the batch creation request. This typically includes a list of the created company objects and may also contain information about any errors encountered for companies that failed to create.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of contact creation requests. Each object in the list defines the properties and associations for a single new contact. Up to 100 contacts can be created in a single batch request. For example: [ { "associations": [ { "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 1 } ], "to": { "id": "25496222837" } } ], "properties": { "email": "new.contact@example.com", "firstname": "John", "lastname": "Doe", "company": "Example Corp" } } ]

The response from the HubSpot API. This typically includes a 'status' field (e.g., 'COMPLETE'), a 'results' list with details for each created contact, and 'startedAt'/'completedAt' timestamps. If errors occurred, 'errors' may also be present.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of email objects to create, each defining its properties and associations.

Response data, including creation status and details of created email objects.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The ID of the original email content to use as a template for the new variation.

A unique name for the new A/B test variation.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A dictionary of properties for the new campaign. Common properties include 'name', 'campaign_goal', and 'is_ab_test'.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique internal programmatic name for the property group within the specified `objectType`, used for API referencing.

Human-readable label for the property group, displayed in the HubSpot UI.

The CRM object type for which the property group will be created.

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.

The newly created property group object.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Internal name of the email, as displayed on the HubSpot email dashboard.

Current state of the email (e.g., DRAFT, SCHEDULED, PUBLISHED).

The subject line of the marketing email.

True if the email is archived (typically hidden from main dashboard view).

ID (GUID) of the associated HubSpot campaign for tracking/reporting.

Primary language of the email content.

Scheduled ISO 8601 date-time for email publication or sending.

Email subcategory for internal organization or specific types (e.g., 'newsletter').

Domain for sending the email; must be a connected and verified HubSpot sending domain.

URL of the RSS feed for email content. Must be valid and accessible if using RSS features.

Primary 'From' and reply-to email address, unless `from__customReplyTo` is used.

True to send email immediately on publish; false to publish without sending until triggered/scheduled.

The ID of the business unit this email is associated with, if applicable.

Sender name appearing in the 'From' field of the received email.

A dictionary specifying the timing and scheduling details for sending RSS emails (e.g., specific day/time for weekly sends).

The unique identifier for the A/B test associated with this email.

Dictionary of widgets (e.g., text, images, CTAs) and their configurations for email content.

The ID of the feedback survey linked to the email.

Custom URL slug for the email's web version (e.g., 'july-newsletter').

Current A/B test status for this email (e.g., master, variant).

Browser tab title for the email's web version.

Dictionary defining content and layout of flexible, customizable areas in the email template.

Domain for the email's web version; defaults to HubSpot domain if unspecified.

Custom reply-to email address, overrides main 'Reply To' if set.

Specifies the layout to be used for the blog RSS email.

The maximum number of blog posts (RSS entries) to include in a single RSS email.

Dictionary of smart fields for email personalization based on contact properties.

Hours to wait for A/B test results before sending the winning version to remaining recipients.

True to not send to contacts identified by HubSpot as 'graymail' (low engagement).

Path to the email template in HubSpot Design Manager.

ISO 8601 date-time when the web version expires and becomes inaccessible.

The type of blog email, which determines send frequency (e.g., instant, daily, weekly).

The ID of the HubSpot blog to be used for the RSS email.

True to apply HubSpot's send frequency limits, preventing over-mailing.

List of specific contact IDs to explicitly exclude, even if in included lists.

List of specific contact IDs to include as recipients.

Metric (e.g., CLICKS_BY_OPENS) to determine the A/B test winning version.

Plain text version of the email, for non-HTML clients or recipient preference.

Dictionary of widget containers for grouping and managing widgets in the email template.

The HTML template for formatting each individual RSS entry within the email.

Percentage of recipients in the A/B test group (e.g., 20 for 20%).

List of contact list IDs whose members to explicitly exclude.

List of contact list IDs whose members to include as recipients.

Custom URL for redirect if web version link is expired/deactivated.

The maximum width for images included from the blog feed in the RSS email.

Default email version (master/variant) if A/B test is inconclusive after the test period.

Meta description for the web version, used by search engines.

Dictionary of theme settings values to customize email appearance.

Default email version (master/variant) if A/B test sample size is too small for significance.

ID of a HubSpot page for redirect if web version link is expired/deactivated.

If true, the email subject will be automatically populated from the blog post headline for RSS emails.

ID of the specific subscription type (e.g., newsletter, product updates).

ID of the office location for CAN-SPAM compliance and personalization.

ID of the subscription preferences group for managing recipient preferences.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Optional, user-defined unique name for the new association type (e.g., 'contact_to_company_custom'). If not supplied, HubSpot may generate a default.

Fully qualified name (e.g., 'contacts') or object type ID (e.g., '2-12345') of the primary object schema for which the new association type is being defined.

Object type ID or fully qualified name (e.g., 'companies' or '0-2') for the 'to' side of the new association type, defining the target object in the relationship.

Object type ID or fully qualified name (e.g., 'contacts' or '0-1') for the 'from' side of the new association type, defining the origin object in the relationship.

Details of the newly created association type definition, including `fromObjectTypeId`, `toObjectTypeId`, `name`, and label.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of contact creation requests. Each object in the list defines the properties and associations for a single new contact. Up to 100 contacts can be created in a single batch request. For example: [ { "associations": [ { "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 1 } ], "to": { "id": "25496222837" } } ], "properties": { "email": "new.contact@example.com", "firstname": "John", "lastname": "Doe", "company": "Example Corp" } } ]

The response from the HubSpot API. This typically includes a 'status' field (e.g., 'COMPLETE'), a 'results' list with details for each created contact, and 'startedAt'/'completedAt' timestamps. If errors occurred, 'errors' may also be present.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

HubSpot API response, including results for each deal creation attempt.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

A dictionary containing the results of the batch creation operation. This typically includes a list of created feedback submissions (often under a 'results' key), status information, and any errors that occurred for specific submissions.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of line items to create, each with its own properties and associations.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of objects to be created in batch. Each item in the list defines the properties and associations for a new object.

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.

A dictionary containing the results of the batch creation. This typically includes a list of the created objects, possibly with their IDs, and any errors encountered for specific objects within the batch.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of definitions for the new properties to be created.

Target HubSpot CRM object type (e.g., 'contacts', 'companies', 'deals', or custom object ID) for property creation.

API response, usually a list of created properties with details, or status/error info for batch items.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Response from the HubSpot API, typically including 'status', 'results' (list of created tickets), 'errors', and timestamps.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Campaign name.

Campaign type.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of campaign objects to create.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Company's postal code.

City where the company is located.

Company name.

Type of company.

Company's primary phone number.

State or region where the company is located.

Company's primary domain name.

Company street address.

Country where the company is located.

Company's website URL.

Company description or about us information.

Additional address information (suite, floor, etc.).

Industry the company operates in.

Company's timezone.

Whether the company is publicly traded.

Brief description of the company.

List of associations to create with other existing HubSpot objects.

Year the company was founded.

Company's annual revenue.

Current lifecycle stage of the company.

Custom properties for the company.

Number of employees in the company.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The postal or ZIP code of the company.

The city where the company is located.

The name of the company.

The type or category of the company.

The company's phone number.

The state or region where the company is located.

The company's domain name.

The company's street address.

The country where the company is located.

The company's website URL.

Detailed information about the company.

Additional address information.

The HubSpot score of the company.

The industry sector of the company.

The timezone of the company's primary location.

Whether the company is publicly traded.

The date when the company record was created.

A brief description of the company.

Associations represent the relationships between objects and activities in the HubSpot CRM.

The year the company was founded.

The annual revenue of the company.

The company's Twitter handle.

The lead status of the company in HubSpot.

The lifecycle stage of the company.

The parent company, if applicable.

The HubSpot owner ID associated with the company.

Custom properties of the Contact object to be set. For example {`custom_property_1`: `value for custom property 1`, `custom_property_2`: `value for custom property 2`}.

The number of employees in the company.

The date when the company notes were last updated.

The date when the company record was last modified.

The company's Facebook page URL.

The company's LinkedIn page URL.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The contact's fax number.

The contact's postal code or ZIP code.

The city where the contact resides.

The primary email address of the contact. This is a unique identifier for contacts in HubSpot.

The contact's primary phone number (often a business phone).

URL of the contact's photo or avatar.

The state or region where the contact resides.

The contact's highest completed educational degree.

The contact's gender.

The name of the school, college, or university the contact attended.

The contact's street address, including apartment or unit number.

The name of the company the contact works for. If `associatedcompanyid` is set, this field might be auto-populated.

The country where the contact resides.

The city associated with the contact's IP address, often captured during their first website visit or form submission.

A free-text message or note often captured from a form submission's message field.

The URL of the contact's personal or company website.

The primary industry of the company the contact works for.

The state or region associated with the contact's IP address.

The contact's job title.

The contact's last name.

The date when the deal associated with this contact was closed. Expected format is a UTC timestamp in milliseconds.

The contact's first name.

The approximate latitude and longitude associated with the contact's IP address, typically in 'latitude,longitude' format.

The total number of notes logged on the contact's record.

The full name of the HubSpot user who owns this contact. Read-only.

The contact's seniority level within their organization.

The date and time when the contact record was created in HubSpot. This is a read-only property, typically a UTC timestamp.

The country associated with the contact's IP address.

The postal code or ZIP code associated with the contact's IP address.

The email address of the HubSpot user who owns this contact. Read-only, reflects the owner's primary email.

The salutation for the contact (e.g., 'Mr.', 'Ms.', 'Dr.').

The contact's start date, typically referring to their employment start date at their current company. Format can vary.

The contact's biography from their Twitter profile.

The contact's work email address. This might be different from the primary `email` if that's a personal address.

The contact's biography from their LinkedIn profile.

The contact's mobile phone number.

List of associations to create with other existing HubSpot objects (e.g., companies, deals).

The size of the company the contact works for, often categorized (e.g., '1-10 employees', '501-1000 employees').

The contact's HubSpot lead score, calculated based on criteria defined in your HubSpot portal's scoring settings.

The contact's job function or department.

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.

The annual revenue of the company the contact works for.

The contact's date of birth. Format can vary, but YYYY-MM-DD is common.

The number of days it took to close the deal associated with this contact. This is usually calculated automatically.

The number of followers the contact has on a specified social media platform (e.g., Twitter).

The state or region code associated with the contact's IP address (e.g., US state code).

The total revenue generated from all closed-won deals associated with this contact.

The contact's Twitter username (handle), without the '@' symbol.

The contact's primary field of study during their education.

The contact's current stage in your sales and marketing funnel (e.g., 'Lead', 'Marketing Qualified Lead', 'Customer'). These stages are customizable in HubSpot.

The contact's marital status.

The contact's graduation date from their educational institution. Format can vary.

A semicolon-separated list of all HubSpot Team IDs this contact is or has been associated with.

The ID of the HubSpot team that owns this contact.

The two-letter country code (ISO 3166-1 alpha-2) associated with the contact's IP address.

The contact's military status.

A semicolon-separated list of all HubSpot Owner IDs who have been assigned to this contact at some point.

The ID of the HubSpot user who is the current owner of this contact.

The date and time when the contact record was last modified. This is a read-only property, UTC timestamp.

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'}`.

The contact's general Klout score, if available and integrated. Klout was a service that rated social media influence.

The date and time when the notes on the contact record were last updated. UTC timestamp in milliseconds.

The amount of the most recent closed-won deal associated with this contact.

The ID of the primary company associated with this contact. This is a read-only property automatically updated when an association is made.

Indicates whether the contact is currently active in any HubSpot workflow. Boolean value, 'true' or 'false'.

A semicolon-separated list of all HubSpot Contact VID (Visitor ID) values associated with this contact, typically used for merging contacts.

The original source that generated the contact (e.g., 'Organic Search', 'Paid Social', 'Referrals').

The number of LinkedIn connections the contact has.

The number of notes on the contact record that relate to being contacted (e.g., call logs, meeting notes).

The contact's self-reported relationship status.

URL of the contact's Twitter profile photo.

A semicolon-separated list of additional email addresses for the contact.

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.

The date and time the contact was last contacted, based on logged activities like calls, emails, or meetings. UTC timestamp in milliseconds.

The total number of deals currently associated with this contact.

The date and time of the contact's first conversion (e.g., form submission). UTC timestamp.

The last URL on your website that the contact visited.

The total number of conversion events (e.g., form submissions, CTA clicks) attributed to this contact.

The first URL on your website that the contact visited.

The date and time of the contact's most recent conversion event. UTC timestamp.

The close date of the most recent closed-won deal associated with this contact. UTC timestamp in milliseconds.

The date and time when the first deal was created for this contact. UTC timestamp.

The total number of sessions (visits) the contact has had on your website.

Timestamp of the last update related to a webinar event (e.g., GoToWebinar) for this contact, if integrated. UTC timestamp.

The date and time of the next scheduled activity (e.g., task, meeting) with the contact. UTC timestamp in milliseconds.

A semicolon-separated list of HubSpot Team IDs that have access to this contact record.

The last referring URL that brought the contact to your website before their most recent session.

Additional detail for the source. For 'Organic search', this might be the search engine. For 'Paid social', this could be the social media platform.

Further detail for the source. For 'Organic search', this might be the keyword. For 'Paid social', this could be the campaign name.

The date and time when a HubSpot owner was most recently assigned to this contact. UTC timestamp in milliseconds.

The name or identifier of the event that marked the contact's first conversion.

The first referring URL that brought the contact to your website.

Timestamp of the contact's last recorded interaction (e.g., last website visit, form submission). UTC timestamp.

The total number of pages viewed by the contact on your website.

The timestamp of the last update to the primary associated company. This is a read-only property.

Timestamp of the contact's first recorded interaction (e.g., first website visit). UTC timestamp.

The number of unique types of conversion events completed by the contact.

The name or identifier of the contact's most recent conversion event.

Timestamp of the last update related to a SurveyMonkey event for this contact, if integrated. UTC timestamp.

Timestamp of the last meeting booked with the contact through HubSpot's meetings tool.

The average number of pages viewed by the contact per session on your website, tracked by HubSpot analytics.

A semicolon-separated list of Business Unit IDs assigned to this contact, if using HubSpot's Business Units feature.

Timestamp of the contact's most recent visit to your website. UTC timestamp.

Timestamp of the contact's first visit to your website. UTC timestamp.

The total number of HubSpot custom events completed by the contact.

The medium (e.g., 'Meetings Tool', 'Email') through which the last meeting was booked.

The source (e.g., 'SALES', 'MARKETING') of the last meeting booked.

The HubSpot campaign ID (GUID) associated with the last meeting booked.

The HubSpot campaign ID (GUID) of the campaign that led to the contact's most recent conversion.

The HubSpot campaign ID (GUID) of the campaign that led to the contact's first conversion.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The contact's fax number.

The contact's postal code or ZIP code.

The city where the contact resides.

The primary email address of the contact. This is a unique identifier for contacts in HubSpot.

The contact's primary phone number (often a business phone).

URL of the contact's photo or avatar.

The state or region where the contact resides.

The contact's highest completed educational degree.

The contact's gender.

The name of the school, college, or university the contact attended.

The contact's street address, including apartment or unit number.

The name of the company the contact works for. If `associatedcompanyid` is set, this field might be auto-populated.

The country where the contact resides.

The city associated with the contact's IP address, often captured during their first website visit or form submission.

A free-text message or note often captured from a form submission's message field.

The URL of the contact's personal or company website.

The primary industry of the company the contact works for.

The state or region associated with the contact's IP address.

The contact's job title.

The contact's last name.

The date when the deal associated with this contact was closed. Expected format is a UTC timestamp in milliseconds.

The contact's first name.

The approximate latitude and longitude associated with the contact's IP address, typically in 'latitude,longitude' format.

The total number of notes logged on the contact's record.

The full name of the HubSpot user who owns this contact. Read-only.

The contact's seniority level within their organization.

The date and time when the contact record was created in HubSpot. This is a read-only property, typically a UTC timestamp.

The country associated with the contact's IP address.

The postal code or ZIP code associated with the contact's IP address.

The email address of the HubSpot user who owns this contact. Read-only, reflects the owner's primary email.

The salutation for the contact (e.g., 'Mr.', 'Ms.', 'Dr.').

The contact's start date, typically referring to their employment start date at their current company. Format can vary.

The contact's biography from their Twitter profile.

The contact's work email address. This might be different from the primary `email` if that's a personal address.

The contact's biography from their LinkedIn profile.

The contact's mobile phone number.

List of associations to create with other existing HubSpot objects (e.g., companies, deals).

The size of the company the contact works for, often categorized (e.g., '1-10 employees', '501-1000 employees').

The contact's HubSpot lead score, calculated based on criteria defined in your HubSpot portal's scoring settings.

The contact's job function or department.

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.

The annual revenue of the company the contact works for.

The contact's date of birth. Format can vary, but YYYY-MM-DD is common.

The number of days it took to close the deal associated with this contact. This is usually calculated automatically.

The number of followers the contact has on a specified social media platform (e.g., Twitter).

The state or region code associated with the contact's IP address (e.g., US state code).

The total revenue generated from all closed-won deals associated with this contact.

The contact's Twitter username (handle), without the '@' symbol.

The contact's primary field of study during their education.

The contact's current stage in your sales and marketing funnel (e.g., 'Lead', 'Marketing Qualified Lead', 'Customer'). These stages are customizable in HubSpot.

The contact's marital status.

The contact's graduation date from their educational institution. Format can vary.

A semicolon-separated list of all HubSpot Team IDs this contact is or has been associated with.

The ID of the HubSpot team that owns this contact.

The two-letter country code (ISO 3166-1 alpha-2) associated with the contact's IP address.

The contact's military status.

A semicolon-separated list of all HubSpot Owner IDs who have been assigned to this contact at some point.

The ID of the HubSpot user who is the current owner of this contact.

The date and time when the contact record was last modified. This is a read-only property, UTC timestamp.

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'}`.

The contact's general Klout score, if available and integrated. Klout was a service that rated social media influence.

The date and time when the notes on the contact record were last updated. UTC timestamp in milliseconds.

The amount of the most recent closed-won deal associated with this contact.

The ID of the primary company associated with this contact. This is a read-only property automatically updated when an association is made.

Indicates whether the contact is currently active in any HubSpot workflow. Boolean value, 'true' or 'false'.

A semicolon-separated list of all HubSpot Contact VID (Visitor ID) values associated with this contact, typically used for merging contacts.

The original source that generated the contact (e.g., 'Organic Search', 'Paid Social', 'Referrals').

The number of LinkedIn connections the contact has.

The number of notes on the contact record that relate to being contacted (e.g., call logs, meeting notes).

The contact's self-reported relationship status.

URL of the contact's Twitter profile photo.

A semicolon-separated list of additional email addresses for the contact.

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.

The date and time the contact was last contacted, based on logged activities like calls, emails, or meetings. UTC timestamp in milliseconds.

The total number of deals currently associated with this contact.

The date and time of the contact's first conversion (e.g., form submission). UTC timestamp.

The last URL on your website that the contact visited.

The total number of conversion events (e.g., form submissions, CTA clicks) attributed to this contact.

The first URL on your website that the contact visited.

The date and time of the contact's most recent conversion event. UTC timestamp.

The close date of the most recent closed-won deal associated with this contact. UTC timestamp in milliseconds.

The date and time when the first deal was created for this contact. UTC timestamp.

The total number of sessions (visits) the contact has had on your website.

Timestamp of the last update related to a webinar event (e.g., GoToWebinar) for this contact, if integrated. UTC timestamp.

The date and time of the next scheduled activity (e.g., task, meeting) with the contact. UTC timestamp in milliseconds.

A semicolon-separated list of HubSpot Team IDs that have access to this contact record.

The last referring URL that brought the contact to your website before their most recent session.

Additional detail for the source. For 'Organic search', this might be the search engine. For 'Paid social', this could be the social media platform.

Further detail for the source. For 'Organic search', this might be the keyword. For 'Paid social', this could be the campaign name.

The date and time when a HubSpot owner was most recently assigned to this contact. UTC timestamp in milliseconds.

The name or identifier of the event that marked the contact's first conversion.

The first referring URL that brought the contact to your website.

Timestamp of the contact's last recorded interaction (e.g., last website visit, form submission). UTC timestamp.

The total number of pages viewed by the contact on your website.

The timestamp of the last update to the primary associated company. This is a read-only property.

Timestamp of the contact's first recorded interaction (e.g., first website visit). UTC timestamp.

The number of unique types of conversion events completed by the contact.

The name or identifier of the contact's most recent conversion event.

Timestamp of the last update related to a SurveyMonkey event for this contact, if integrated. UTC timestamp.

Timestamp of the last meeting booked with the contact through HubSpot's meetings tool.

The average number of pages viewed by the contact per session on your website, tracked by HubSpot analytics.

A semicolon-separated list of Business Unit IDs assigned to this contact, if using HubSpot's Business Units feature.

Timestamp of the contact's most recent visit to your website. UTC timestamp.

Timestamp of the contact's first visit to your website. UTC timestamp.

The total number of HubSpot custom events completed by the contact.

The medium (e.g., 'Meetings Tool', 'Email') through which the last meeting was booked.

The source (e.g., 'SALES', 'MARKETING') of the last meeting booked.

The HubSpot campaign ID (GUID) associated with the last meeting booked.

The HubSpot campaign ID (GUID) of the campaign that led to the contact's most recent conversion.

The HubSpot campaign ID (GUID) of the campaign that led to the contact's first conversion.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Type of CRM object to create (e.g., 'contacts', 'companies', 'deals', or custom object schema ID like 'p12345678').

Key-value pairs for the object's properties. Keys must be internal HubSpot property names valid for the `objectType` (e.g., 'email', 'firstname'), and values are the data to set.

List of associations to create between the new object and existing CRM objects, using `to_id` and `types`.

Dictionary with properties and data of the created CRM object, including its unique ID and timestamps.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Total monetary value of the deal.

Annual Contract Value (ACV) (HubSpot-calculated).

Annual Recurring Revenue (ARR) (HubSpot-calculated).

Monthly Recurring Revenue (MRR) (HubSpot-calculated).

Total Contract Value (TCV) (HubSpot-calculated).

Descriptive name or title of the deal.

Type of deal (e.g., 'newbusiness', 'existingbusiness').

ID of the sales pipeline for this deal (required).

Date (YYYY-MM-DD) or datetime (ISO 8601) when the deal closed or is expected to close.

ID of the deal's current stage in its pipeline.

Date/time deal was created (read-only, HubSpot-set).

Detailed text description of the deal.

GUID of the HubSpot campaign that generated this deal.

Priority level (e.g., 'high', 'medium', 'low').

Associations to create between the new deal and other CRM objects (e.g., contact, company).

Indicates if deal is closed ('true'/'false'; read-only, from deal stage properties).

Next planned step for this deal.

Unique ID of the deal object (read-only, HubSpot-assigned).

Days between creation and close (read-only, HubSpot-calculated).

Specific date/time deal record created (ISO 8601, read-only, HubSpot-set).

Semicolon-separated list of all associated team IDs (owner's primary, additional teams; typically read-only).

Semicolon-separated list of all owner IDs (primary, co-owners).

Actual amount when deal closed (HubSpot-calculated).

ID of the HubSpot user owning the deal; may be auto-assigned if unspecified.

Reason why the deal was won.

Custom properties for the deal. Keys are internal property names, values are the values to set. E.g., `{'internal_name_1': 'value1'}`.

Reason why the deal was lost.

Currency code (e.g., USD) for deal amount; defaults to company's home currency.

Forecasted amount ('Amount' * 'hs_deal_stage_probability'; HubSpot-calculated).

Original deal source per HubSpot analytics (e.g., 'Organic Search'; typically read-only).

Date/time deal last modified (ISO 8601, read-only, HubSpot-updated).

Projected deal amount (manually set or calculated).

Deal's value in company's home currency (read-only, HubSpot-calculated).

Sales forecasting probability; may differ from 'hs_deal_stage_probability'.

Win probability (decimal, e.g., 0.5) based on current stage; typically stage-defined.

Semicolon-separated list of team IDs with access (typically read-only).

Date/time of last booked meeting for this deal (typically read-only).

Semicolon-separated list of assigned business unit IDs (for Business Units add-on).

Closed amount in home currency (HubSpot-calculated).

Projected amount in home currency (HubSpot-calculated).

Medium (e.g., 'Meetings') of last booked meeting (typically read-only).

Source (e.g., 'Calendar') of last booked meeting (typically read-only).

Campaign ID for the last booked meeting (typically read-only).

Dictionary with properties and details of the new deal, including standard and custom properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Email properties to set. Keys are HubSpot internal property names.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of email objects to create.

API response with operation status and results.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the event template, unique for the app and object type.

The unique identifier of the target HubSpot app.

Defines custom properties (tokens) for the event, which can populate CRM object properties if a token's `objectPropertyName` is set.

The CRM object type this event template is associated with (e.g., 'contacts', 'companies').

Optional Markdown string with Handlebars templating for rendering HTML for expanded event details on the CRM timeline, using tokens for event-specific data.

Optional Markdown string with Handlebars templating for rendering HTML for the event header on the CRM timeline, using tokens for event-specific data.

Full details of the newly created event template.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

Associations between this feedback submission and other CRM objects, specifying target object ID and association types.

Details of the created feedback submission, including its ID and creation timestamp.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Key-value pairs for the line item's properties (e.g., 'name', 'quantity', 'price'). Consult HubSpot documentation for all properties required by your specific instance.

Links the new line item with other CRM objects (e.g., deals, quotes). Provide an empty list if the API supports creating unassociated line items.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of line item objects to create.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Total monetary value of the deal.

Annual Contract Value (ACV) (HubSpot-calculated).

Annual Recurring Revenue (ARR) (HubSpot-calculated).

Monthly Recurring Revenue (MRR) (HubSpot-calculated).

Total Contract Value (TCV) (HubSpot-calculated).

Descriptive name or title of the deal.

Type of deal (e.g., 'newbusiness', 'existingbusiness').

ID of the sales pipeline for this deal (required).

Date (YYYY-MM-DD) or datetime (ISO 8601) when the deal closed or is expected to close.

ID of the deal's current stage in its pipeline.

Date/time deal was created (read-only, HubSpot-set).

Detailed text description of the deal.

GUID of the HubSpot campaign that generated this deal.

Priority level (e.g., 'high', 'medium', 'low').

Associations to create between the new deal and other CRM objects (e.g., contact, company).

Indicates if deal is closed ('true'/'false'; read-only, from deal stage properties).

Next planned step for this deal.

Unique ID of the deal object (read-only, HubSpot-assigned).

Days between creation and close (read-only, HubSpot-calculated).

Specific date/time deal record created (ISO 8601, read-only, HubSpot-set).

Semicolon-separated list of all associated team IDs (owner's primary, additional teams; typically read-only).

Semicolon-separated list of all owner IDs (primary, co-owners).

Actual amount when deal closed (HubSpot-calculated).

ID of the HubSpot user owning the deal; may be auto-assigned if unspecified.

Reason why the deal was won.

Custom properties for the deal. Keys are internal property names, values are the values to set. E.g., `{'internal_name_1': 'value1'}`.

Reason why the deal was lost.

Currency code (e.g., USD) for deal amount; defaults to company's home currency.

Forecasted amount ('Amount' * 'hs_deal_stage_probability'; HubSpot-calculated).

Original deal source per HubSpot analytics (e.g., 'Organic Search'; typically read-only).

Date/time deal last modified (ISO 8601, read-only, HubSpot-updated).

Projected deal amount (manually set or calculated).

Deal's value in company's home currency (read-only, HubSpot-calculated).

Sales forecasting probability; may differ from 'hs_deal_stage_probability'.

Win probability (decimal, e.g., 0.5) based on current stage; typically stage-defined.

Semicolon-separated list of team IDs with access (typically read-only).

Date/time of last booked meeting for this deal (typically read-only).

Semicolon-separated list of assigned business unit IDs (for Business Units add-on).

Closed amount in home currency (HubSpot-calculated).

Projected amount in home currency (HubSpot-calculated).

Medium (e.g., 'Meetings') of last booked meeting (typically read-only).

Source (e.g., 'Calendar') of last booked meeting (typically read-only).

Campaign ID for the last booked meeting (typically read-only).

Dictionary with properties and details of the new deal, including standard and custom properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique, immutable programmatic name for the schema (used in API calls); must be unique in the account.

List of property definitions for this custom object schema.

Optional human-readable description for the custom object schema.

Plural display name used in HubSpot UI; immutable after creation.

Singular display name used in HubSpot UI; immutable after creation.

Object type IDs (e.g., 'CONTACT', 'COMPANY', 'p123456') this schema can be associated with.

Internal names of properties required for new records; must be defined in 'properties'.

Internal names of properties indexed for global search; must be defined in 'properties'.

Internal name of the primary identifier property; must be defined in 'properties'.

Internal names of properties for secondary display on record pages; must be defined in 'properties'.

A dictionary containing the details of the newly created custom object schema, including its system-generated ID (objectTypeId), fully qualified name, properties, and associations.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Internal name of the email for HubSpot dashboard.

Current state of the email (e.g., 'DRAFT'); typically system-managed.

The unique identifier of the marketing email.

The subject line of the email.

Indicates if the marketing email is archived.

Associated HubSpot campaign ID for tracking/reporting.

Primary language of email content (e.g., 'en', 'en-us').

Scheduled send date/time (ISO 8601). Used for scheduled emails.

Email subcategory for organization/reporting (e.g., 'MARKETING_EMAIL').

Connected and verified sending domain in HubSpot.

External RSS feed URL. Required for external blog RSS emails.

'From' email address; receives replies if `customReplyTo` is not set.

If true, sends email immediately on publishing, overriding `publishDate`.

Associated business unit ID, for accounts with multiple units.

'From' name displayed to recipients.

Send timing for RSS emails. Applies if `rssData` is configured.

Unique identifier of the A/B test, if applicable.

Configuration for widgets (modules) in email content.

URL slug for the web version (e.g., 'july-newsletter').

Current status of the A/B test.

Browser tab title for the web version.

Configuration for flexible content areas in the email template.

Domain for the email web version; defaults to HubSpot domain if unspecified.

Custom reply-to email address; overrides `replyTo`.

Layout style for blog posts in RSS email. Applies if `rssData` is configured.

Maximum blog posts per RSS email. Applies if `rssData` is configured.

Smart fields and values for email personalization.

Hours to wait for A/B test results before sending the winning version.

If true, suppresses sending to 'graymail' contacts.

Path to the email template in HubSpot Design Manager.

Expiration date/time (ISO 8601) for the web version link.

Type of RSS email (e.g., 'instant', 'daily', 'weekly'). Applies if `rssData` is configured.

HubSpot-hosted blog ID for RSS-to-Email. Applies if `rssData` is configured and blog is HubSpot-hosted.

If true, respects contact send frequency limits.

Specific contact IDs to exclude from recipients.

Specific contact IDs to include as recipients.

Metric to determine A/B test winning version (e.g., 'CLICKS_BY_OPENS').

Plain text version of the email.

Configuration for widget containers in the email template.

HTML template for each RSS entry. Applies if `rssData` is configured.

Percentage of recipients in the A/B test group (e.g., 20 for 20%).

Contact list IDs whose members will be excluded.

Contact list IDs whose members will be included as recipients.

Custom URL to redirect to from web version link if `redirectToPageId` is not set.

Maximum width for images imported from RSS feed blog posts. Applies if `rssData` is configured.

Default email version ('master' or 'variant') if A/B test results are inconclusive.

Meta description for the web version (for search engines).

Custom values for theme settings applied to the email template.

Default email version ('master' or 'variant') if A/B test sample size is too small.

HubSpot page ID to redirect to from web version link; overrides `redirectToUrl`.

If true, email subject is first blog post headline. Applies if `rssData` is configured.

Specific subscription type ID (e.g., newsletter).

Company office location ID for email footer (compliance).

Associated subscription preferences group ID.

Details of the created or updated draft email.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A unique label for the pipeline, used for organization in the HubSpot UI for this object type.

A list of stage definitions for the new pipeline; each stage `label` must be unique within this pipeline.

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.

Display order for this pipeline. Pipelines for the same object type with matching `displayOrder` are sorted alphabetically by label.

A dictionary containing the full details of the newly created pipeline, including its unique ID, label, display order, and defined stages.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

User-visible name for the pipeline stage, unique within the parent pipeline.

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.

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.

Identifier of the existing pipeline (specific to `objectType`) where the new stage will be added.

Stage's display order in the pipeline (lower numbers first). Stages with identical `displayOrder` are sorted alphabetically by `label`.

A dictionary containing the properties of the newly created pipeline stage, including its ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The official name of the product.

The selling price of the product in the default currency of the HubSpot account.

The Stock Keeping Unit (SKU) for the product. This should be unique across all products if used for inventory management.

A direct URL link to the product's page on an e-commerce website or product information site.

The current quantity of the product available in inventory. This property might be relevant for physical goods.

Indicates if the product is currently active and available for sale. Set to `true` if active, `false` otherwise.

A comma-separated string of URLs for product images. The first URL is typically used as the primary image.

A detailed description of the product, its features, and benefits.

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.

A list of associations to create between this new product and other CRM objects. Each association specifies the target object ID and the type of relationship.

The tax category or code applicable to the product, used for calculating sales tax (e.g., 'Taxable Goods', 'Non-Taxable').

An external or secondary unique identifier for the product. Useful for mapping to external systems. HubSpot does not auto-generate this.

The date (YYYY-MM-DD format) from which the product is considered valid or available for sale.

The general type of the product (e.g., 'Physical Good', 'Service', 'Software License').

The date (YYYY-MM-DD format) until which the product is considered valid or available. Leave empty if there's no expiration date.

A dictionary of custom properties for the product. Keys are the internal names of your HubSpot custom product properties, and values are the respective property values. Example: `{"material": "Titanium", "warranty_years": "5"}`.

The current sales or lifecycle status of the product (e.g., 'Available', 'Discontinued', 'Pre-order', 'Out of Stock').

The primary category the product belongs to (e.g., 'Electronics', 'Apparel', 'Consulting Services').

The cost of goods sold (COGS) for the product. Used for profit margin calculations.

A more specific subcategory for the product (e.g., 'Laptops' under 'Electronics').

The billing frequency for recurring revenue products, formatted as a PnYnMnDTnHnMnS string (e.g., P1M for 1 month, P1Y for 1 year).

A dictionary containing all properties of the newly created HubSpot product object, including its unique HubSpot ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of product definitions. Each item in the list represents a distinct product to be created, complete with its properties and any desired associations to other CRM objects.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The official name of the product.

The selling price of the product in the default currency of the HubSpot account.

The Stock Keeping Unit (SKU) for the product. This should be unique across all products if used for inventory management.

A direct URL link to the product's page on an e-commerce website or product information site.

The current quantity of the product available in inventory. This property might be relevant for physical goods.

Indicates if the product is currently active and available for sale. Set to `true` if active, `false` otherwise.

A comma-separated string of URLs for product images. The first URL is typically used as the primary image.

A detailed description of the product, its features, and benefits.

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.

A list of associations to create between this new product and other CRM objects. Each association specifies the target object ID and the type of relationship.

The tax category or code applicable to the product, used for calculating sales tax (e.g., 'Taxable Goods', 'Non-Taxable').

An external or secondary unique identifier for the product. Useful for mapping to external systems. HubSpot does not auto-generate this.

The date (YYYY-MM-DD format) from which the product is considered valid or available for sale.

The general type of the product (e.g., 'Physical Good', 'Service', 'Software License').

The date (YYYY-MM-DD format) until which the product is considered valid or available. Leave empty if there's no expiration date.

A dictionary of custom properties for the product. Keys are the internal names of your HubSpot custom product properties, and values are the respective property values. Example: `{"material": "Titanium", "warranty_years": "5"}`.

The current sales or lifecycle status of the product (e.g., 'Available', 'Discontinued', 'Pre-order', 'Out of Stock').

The primary category the product belongs to (e.g., 'Electronics', 'Apparel', 'Consulting Services').

The cost of goods sold (COGS) for the product. Used for profit margin calculations.

A more specific subcategory for the product (e.g., 'Laptops' under 'Electronics').

The billing frequency for recurring revenue products, formatted as a PnYnMnDTnHnMnS string (e.g., P1M for 1 month, P1Y for 1 year).

A dictionary containing all properties of the newly created HubSpot product object, including its unique HubSpot ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of product objects to create.

API response with operation status and results.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Internal programmatic name (snake_case), unique within the `objectType`, used for API referencing.

The data type of the property.

Human-readable label for the property shown in HubSpot UI.

If true, hides property in HubSpot UI, lists, and forms. Defaults to false if not set.

List of predefined options, required if `type` is 'enumeration'; each option defines a possible value.

Controls UI display and interaction method (e.g., text input, dropdown, checkbox).

If true, property can be used in HubSpot forms. Defaults to false if not set.

Name of the property group for organization in HubSpot UI.

Target HubSpot CRM object type (e.g., contacts, companies) for the new property. Case-sensitive.

Optional description for the property, displayed as help text in HubSpot UI.

Controls display order of properties in HubSpot UI, sorted ascending; -1 displays after positive values.

If true, property's value must be unique across all records for the `objectType`. Cannot be changed to false after being set to true.

If true, 'enumeration' options are sourced externally, requiring `referencedObjectType` (e.g., 'OWNER' for HubSpot users). Defaults to false. Only for 'enumeration' type.

Formula for calculated property, required if `fieldType` is 'calculation_equation'. Can reference other properties by their internal names.

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.

Dictionary with the definition and attributes of the created property.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A dictionary of key-value pairs representing the properties of the quote to be created. Property names are HubSpot internal names.

A list of associations to create for the new quote. Each item specifies the object to associate with and the type of association.

A dictionary containing the properties of the newly created quote object, including its ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Main body or description of the ticket, detailing the issue or request; typically required.

Subject line or title of the ticket; typically a required field.

ID of the HubSpot user who created the ticket.

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.

List of tag IDs associated with the ticket for categorization or filtering.

Date and time the ticket was closed (ISO 8601 format, e.g., 'YYYY-MM-DDTHH:mm:ssZ').

ID of the pipeline this ticket belongs to; often a required field.

Source channel through which the ticket was created (e.g., 'EMAIL', 'CHAT', 'PHONE', 'API').

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`).

Time taken to close the ticket, often in milliseconds or ISO 8601 duration (e.g. 'PT2H30M').

List of all team IDs associated with this ticket; usually managed by HubSpot.

ID of the HubSpot team this ticket is assigned to.

Date and time of the last reply (either from agent or contact) on this ticket (ISO 8601 format).

List of all HubSpot owner IDs associated with this ticket; usually managed by HubSpot.

Date and time of the last contact associated with this ticket (ISO 8601 format).

ID of the HubSpot user who owns this ticket.

Dictionary of custom properties for the ticket: keys are internal names (e.g., `my_custom_field_name`), values are the data.

ID of the current stage of the ticket within its pipeline; often required and must belong to the specified `hs_pipeline`.

ID of the primary company associated with this ticket.

Category of the ticket (e.g., 'Technical Support', 'Billing Inquiry'); values might be HubSpot-defined or custom.

Priority of the ticket (e.g., 'HIGH', 'MEDIUM', 'LOW'); values might be HubSpot-defined or custom.

Timestamp of when the notes for this ticket were last updated (ISO 8601 format).

Date and time this ticket was last modified (ISO 8601 format); HubSpot typically sets this automatically.

List of team IDs specifically assigned to this ticket.

Method used for assigning the ticket (e.g., 'MANUAL', 'AUTOMATIC_ROUND_ROBIN').

Date and time of the last engagement (e.g., email, call) with this ticket (ISO 8601 format).

Timestamp of the last contact logged in notes associated with the ticket (ISO 8601 format).

HubSpot user ID of the person or system that created this ticket.

Date and time of the first agent reply on this ticket (ISO 8601 format).

Timestamp for the next scheduled activity related to this ticket's notes (ISO 8601 format).

List of all team IDs with access to this ticket; usually managed by HubSpot.

System-populated list of all mentions in conversations related to this ticket.

System-populated list of email addresses of contacts associated with this ticket.

System-populated list of phone numbers of contacts associated with this ticket.

If auto-generated from a conversation, the ID of the originating thread.

List of all business unit IDs assigned to this ticket; usually managed by HubSpot.

System-populated list of company names or IDs for contacts linked to this ticket.

System-populated list of last names of contacts associated with this ticket.

System-populated list of first names of contacts associated with this ticket.

System-populated list of mobile phone numbers of contacts associated with this ticket.

ID of the conversation thread from which this ticket originated.

ID of the first message in the conversation that led to this ticket's creation.

Dictionary containing the properties of the newly created HubSpot ticket, including its ID and all set properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Main body or description of the ticket, detailing the issue or request; typically required.

Subject line or title of the ticket; typically a required field.

ID of the HubSpot user who created the ticket.

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.

List of tag IDs associated with the ticket for categorization or filtering.

Date and time the ticket was closed (ISO 8601 format, e.g., 'YYYY-MM-DDTHH:mm:ssZ').

ID of the pipeline this ticket belongs to; often a required field.

Source channel through which the ticket was created (e.g., 'EMAIL', 'CHAT', 'PHONE', 'API').

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`).

Time taken to close the ticket, often in milliseconds or ISO 8601 duration (e.g. 'PT2H30M').

List of all team IDs associated with this ticket; usually managed by HubSpot.

ID of the HubSpot team this ticket is assigned to.

Date and time of the last reply (either from agent or contact) on this ticket (ISO 8601 format).

List of all HubSpot owner IDs associated with this ticket; usually managed by HubSpot.

Date and time of the last contact associated with this ticket (ISO 8601 format).

ID of the HubSpot user who owns this ticket.

Dictionary of custom properties for the ticket: keys are internal names (e.g., `my_custom_field_name`), values are the data.

ID of the current stage of the ticket within its pipeline; often required and must belong to the specified `hs_pipeline`.

ID of the primary company associated with this ticket.

Category of the ticket (e.g., 'Technical Support', 'Billing Inquiry'); values might be HubSpot-defined or custom.

Priority of the ticket (e.g., 'HIGH', 'MEDIUM', 'LOW'); values might be HubSpot-defined or custom.

Timestamp of when the notes for this ticket were last updated (ISO 8601 format).

Date and time this ticket was last modified (ISO 8601 format); HubSpot typically sets this automatically.

List of team IDs specifically assigned to this ticket.

Method used for assigning the ticket (e.g., 'MANUAL', 'AUTOMATIC_ROUND_ROBIN').

Date and time of the last engagement (e.g., email, call) with this ticket (ISO 8601 format).

Timestamp of the last contact logged in notes associated with the ticket (ISO 8601 format).

HubSpot user ID of the person or system that created this ticket.

Date and time of the first agent reply on this ticket (ISO 8601 format).

Timestamp for the next scheduled activity related to this ticket's notes (ISO 8601 format).

List of all team IDs with access to this ticket; usually managed by HubSpot.

System-populated list of all mentions in conversations related to this ticket.

System-populated list of email addresses of contacts associated with this ticket.

System-populated list of phone numbers of contacts associated with this ticket.

If auto-generated from a conversation, the ID of the originating thread.

List of all business unit IDs assigned to this ticket; usually managed by HubSpot.

System-populated list of company names or IDs for contacts linked to this ticket.

System-populated list of last names of contacts associated with this ticket.

System-populated list of first names of contacts associated with this ticket.

System-populated list of mobile phone numbers of contacts associated with this ticket.

ID of the conversation thread from which this ticket originated.

ID of the first message in the conversation that led to this ticket's creation.

Dictionary containing the properties of the newly created HubSpot ticket, including its ID and all set properties.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Response from the HubSpot API, typically including 'status', 'results' (list of created tickets), 'errors', and timestamps.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Optional unique event identifier; HubSpot auto-generates if omitted. Use `{{uuid}}` for uniqueness if providing an ID.

HubSpot user token (e.g., from `hubspotutk` cookie) to associate event with a contact; use if contact's email is unknown.

Email for contact-specific events; identifies existing contact, creates new, or changes email (if `objectId` provided).

Domain associated with the event, often paired with `utk` for contact event context.

Key-value pairs for populating dynamic content in the event template; keys are token names from the template.

Unique identifier of the CRM object (e.g., company, deal) for event association; required for non-contact objects.

ISO 8601 UTC timestamp of event occurrence; defaults to current time. Determines timeline placement.

The unique identifier of the event template, which must exist in HubSpot.

URL of content to display in the iframe.

Width of the iframe modal window (pixels).

Height of the iframe modal window (pixels).

Text for the link that opens the iframe modal with more details.

Title/header for the modal window displaying iframe content.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique name for the workflow.

'CONTACT_FLOW' for contact-based, 'PLATFORM_FLOW' for other object types.

Action configurations defining workflow steps; each dictionary is an action with settings.

Category: 'WORKFLOW' for standard, 'ACTION_SET' for reusable action sets.

Activate workflow upon creation (true) or create disabled (false).

Data source configurations for conditions or personalization.

Explanation of the workflow's purpose and functionality.

Configurations for periods when workflow actions can execute.

Configurations for dates when workflow actions should not execute.

HubSpot internal ID for the object type (e.g., '0-1' for Contacts, '0-2' for Companies).

Custom key-value pairs for organization or tracking.

Configuration defining criteria for object enrollment.

HubSpot list IDs for contacts to be prevented from enrollment.

Defines if/how objects unenroll from other workflows upon enrolling in this one.

Allow contacts to be enrolled directly from Salesforce.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Pagination token from `paging.next.after` of a previous response, used to fetch the subsequent page. Omit for the first page.

Maximum number of contacts to return per page, controlling pagination size (default: 5).

Boolean flag to filter contacts by archived status: `true` returns only archived contacts; `false` (default) returns only active (non-archived) contacts.

List of contact property internal names to include in the response (e.g., "email", "firstname"). If omitted, a default set of properties is returned.

List of object types (e.g., "companies", "deals") for which to retrieve associated IDs with each contact.

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.

The API response, typically a dictionary including a list of contacts and pagination details.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The response body. Note: This action consistently returns a 204 No Content status, indicating that the response body will be empty.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the existing marketing email.

If `true`, archives the email for potential restoration; if `false` or omitted, the email is permanently deleted.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Response data from the API. For a successful deletion, this will typically be an empty dictionary, as HubSpot often returns a 204 No Content status for DELETE operations.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

Response data, which will be an empty dictionary as the API returns a 204 No Content status for successful deletions.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The identifier (e.g., an email address or unique record ID) of the contact to be deleted for GDPR compliance, its type defined by `idProperty`.

The HubSpot property name (e.g., 'email') specifying the type of `objectId` used for GDPR deletion of a contact. If omitted, `objectId` is assumed to be the contact's primary unique ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Type of CRM object associated with the pipeline, determining which pipeline category is affected.

Unique identifier of the pipeline to be deleted.

If true, HubSpot checks for existing references to this pipeline before deletion to prevent data loss or orphaned records.

If true (for deal pipelines), HubSpot verifies if any deals use stages from this pipeline before deletion to prevent disruption.

Response data from the API; typically empty for a successful (204 No Content) pipeline deletion.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Identifier of the pipeline stage to be deleted.

The CRM object type for the pipeline (e.g., 'deals', 'tickets').

Identifier of the pipeline (specific to the `objectType`) from which the stage will be deleted.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Set to `true` to delete an already archived schema; defaults to `false` for deleting an active schema.

The fully qualified name or object type ID of the custom object schema to be deleted, which must uniquely specify the schema.

A dictionary that may contain information related to the outcome of the delete operation. HubSpot typically returns a 204 No Content (empty response) for successful deletions.

Error if any occurred during the execution of the action