Instant Connections

Associates an existing asset ('FORM', 'OBJECT_LIST', or 'EXTERNAL_WEB_URL') with a specified HubSpot marketing campaign.

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

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

Archives a batch of existing line items by their unique IDs in HubSpot CRM; this operation is irreversible via the API.

Archives a batch of existing, non-archived CRM objects of a specified `objectType` by their IDs, effectively hiding them from active use.

Archives a batch of properties by their internal names for a specified HubSpot CRM object type; this operation is idempotent and safe to retry.

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

Archives multiple HubSpot companies by their IDs.

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

Archives a HubSpot contact by its ID.

Archives multiple HubSpot contacts by their IDs.

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

Archives multiple HubSpot deals by their IDs.

Archives the HubSpot email specified by `emailId` by moving it to the recycling bin, making it inaccessible unless restored.

Archives multiple HubSpot emails by their IDs.

Archives an existing, non-archived Feedback Submission in HubSpot CRM by its ID, moving it to the recycling bin (not permanently deleting it).

Archives a specific HubSpot line item by its ID, moving it to a recoverable state.

Archives a HubSpot product by its ID.

Archives multiple HubSpot products by their IDs.

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

Archives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its CRM visibility and usability.

Archives a HubSpot Quote object by ID, moving it to the recycling bin where it can be restored within 90 days.

Archives a HubSpot ticket by its ID.

Archives multiple HubSpot tickets by their IDs.

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

Remove selected labels from up to 100 HubSpot CRM association pairs. Removing a default unlabeled association also removes every label between that record pair.

Creates up to 2,000 labeled contact-to-company associations.

Creates labeled associations from deals to companies in one batch.

Create default unlabeled associations for batches of HubSpot CRM record pairs.

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

Retrieve list memberships for multiple HubSpot CRM records.

Resolves current flow IDs and legacy workflow IDs in one batch.

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

Cancels an active HubSpot data import job using its `importId`; this action is irreversible, and any data already processed will remain.

Duplicates an existing HubSpot marketing email, identified by its `id`, into a new draft; an optional `cloneName` can be assigned to this new email copy.

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

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

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

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

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

Create a custom relationship-label definition between two CRM object types.

Creates a batch of feedback submissions in HubSpot, ideal for bulk imports; all property names, `associationTypeId`s, and association `to_id`s must reference existing entities in HubSpot.

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

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

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

Creates a new HubSpot campaign.

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

Creates multiple new HubSpot companies in a single batch operation.

Creates a new HubSpot company.

Creates a new HubSpot contact.

Creates a new contact in HubSpot from a natural language description. Fetches the contact property schema at runtime, uses an LLM to generate the correct property payload, and creates the contact.

Creates multiple new HubSpot contacts in a single batch operation.

Create a HubSpot Design Manager template from HubL or HTML source.

Creates a new CRM object (contact, deal, company, ticket, or custom object) in HubSpot from a natural language description. Fetches the object's property schema at runtime, uses an LLM to generate the correct property payload, and creates the object.

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

Creates a new HubSpot deal.

Creates a new deal in HubSpot from a natural language description. Fetches the deal property schema and pipeline stages at runtime, uses an LLM to generate the correct property payload, and creates the deal.

Creates multiple deals in HubSpot CRM; ensure any associated object IDs, deal stages, and pipeline IDs specified are valid and exist within the HubSpot account.

Create HubSpot's default unlabeled association between two CRM records.

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

Creates multiple HubSpot emails in a single batch operation.

Create a legacy EMAIL, CALL, MEETING, TASK, or NOTE engagement with optional CRM associations, attachments, and type-specific metadata.

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

Creates a new HubSpot feedback submission to record customer feedback (e.g., survey responses, support interactions), optionally associating it with CRM objects.

Create a HubSpot landing page, as a draft unless state is explicitly set.

Creates a new HubSpot line item.

Creates multiple HubSpot line items in a single batch operation.

Create a HubSpot CRM list with manual, snapshot, or dynamic membership rules.

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

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

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

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

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

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

Creates a new stage in a specified HubSpot CRM pipeline for a given object type, such as 'deals' or 'tickets'.

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

Creates multiple HubSpot products in a single batch operation.

Creates a new custom property for a specified HubSpot CRM object type; ensure `groupName` refers to an existing property group for the `objectType`.

Creates a new quote object in HubSpot CRM with specified properties and associations.

Create a HubSpot website page draft and return its complete page record.

Creates a new CRM task record. Use when adding a task with properties and optional associations.

Creates a new HubSpot ticket.

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

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

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

Creates a new HubSpot workflow to automate processes; ensure `enrollmentCriteria` and `actions` use properties relevant to the specified `objectTypeId`.

Delete one custom relationship-label definition between CRM object types.

Permanently deletes a HubSpot call record by its ID. This action removes a call engagement from the CRM. Use this action when you need to remove a specific call record that is no longer needed or was created in error. This action is irreversible - the call record cannot be recovered once deleted.

Permanently deletes the settings for a calling extension app, specified by its `appId`, rendering it unusable for all connected HubSpot accounts; this operation is irreversible.

Permanently deletes a marketing campaign from HubSpot using its `campaignGuid`; returns a 204 No Content status even if the campaign does not exist.

Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.

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

Irreversibly erases a HubSpot contact and associated data per a GDPR request; if an email is given for a non-existent contact, it's blocklisted.

Soft-deletes a HubSpot CRM list by its ILS list ID.

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

Permanently deletes a specified line item and its associated content for GDPR compliance; this action is irreversible and cannot be undone.

Permanently deletes a marketing email from your HubSpot account. This action cannot be undone.

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

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

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

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

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

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

Permanently and irreversibly deletes a specific timeline event template, identified by its `eventTemplateId`, from the application `appId`.

Irreversibly deletes all settings for a video conferencing application identified by its `appId` in HubSpot, removing its configuration and preventing it from functioning until reconfigured; existing meetings and historical data are unaffected. Note: This API requires developer API key (hapikey) authentication from your HubSpot developer account, not OAuth tokens.

Permanently deletes a HubSpot workflow by its ID; deleted workflows cannot be restored via the API and the ID must exist.

Enrolls a contact, identified by email, in a HubSpot workflow.

Fetches a paginated list of read-only error details for a specific HubSpot CRM import, requiring a valid `importId` for a processed import.

Fetches call recording settings for a specified, existing HubSpot calling extension app.

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

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

Gets current HubSpot account info (email, hubId, user details) using access-token lookup.

Retrieves a list of currently active import jobs in HubSpot for monitoring ongoing data operations.

Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.

Retrieves aggregated statistics for marketing emails, optionally within an ISO8601 formatted time range, by email IDs, or specific email properties.

Fetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics.

Retrieves one HubSpot CMS blog post by post ID.

Retrieves one HubSpot CMS blog tag by tag ID.

Retrieves a HubSpot campaign by its ID.

Retrieves key attribution metrics for an existing marketing campaign, identified by its `campaignGuid`, within an optional date range.

Retrieves multiple HubSpot campaigns.

Retrieves a HubSpot company by its ID.

Fetches a list of contact IDs for a specific HubSpot campaign based on interaction type.

Retrieves the status and available result of a HubSpot CRM export task.

Retrieves a HubSpot CRM list by its ILS list ID.

Retrieves a HubSpot CRM list by object type and exact name.

Retrieves multiple HubSpot CRM lists by their current IDs.

Retrieves a HubSpot deal by its ID.

Retrieves multiple HubSpot deals by their IDs in a single batch request.

Retrieves multiple HubSpot email engagement records by their IDs in a single batch request.

Retrieves legacy overall email delivery and subscription state for an address.

Retrieve one legacy aggregate engagement by its engagement ID.

Retrieves detailed information about a specific event template for a given application in HubSpot's CRM timeline.

Retrieves one HubSpot account exchange rate by ID.

Retrieves a comprehensive summary of a specific HubSpot CRM import record by its `importId`, including status, progress, updates, results, and errors; useful for monitoring and troubleshooting data imports.

Retrieve one HubSpot CMS landing page by page ID.

Retrieve the full editable draft of one HubSpot landing page.

Retrieves the draft version of a marketing email by its `emailId`; if no draft exists, returns the published version.

Retrieves a specific, previously saved revision of a marketing email using its unique email ID and revision ID.

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

Pages participation records for one HubSpot marketing event.

Retrieves a specific pipeline by its ID and CRM object type, detailing its stages and properties.

Retrieves a reverse chronological list of all mutations (changes) for a specific pipeline stage, including CREATE and UPDATE events with timestamps and details.

Retrieve daily private-app API consumption and limits.

Retrieves a HubSpot product by its ID.

Retrieves multiple HubSpot products by their IDs.

Retrieves a specific HubSpot quote by its unique identifier.

Return the HubSpot lists that contain one CRM record.

Tool to retrieve segment (list) members ordered by join timestamp. Use when you need to page through list membership data.

Retrieves one HubSpot settings user by user ID or email.

Retrieve one HubSpot site page by ID.

Retrieve the full editable draft of one HubSpot site page.

Retrieves detailed information for a specific marketing email in HubSpot using its unique email ID, optionally including performance statistics and specific properties.

Retrieves a HubSpot ticket by its ID.

Retrieves multiple HubSpot tickets by their IDs.

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

Return enrolled, completed, and unenrolled workflow counts by time bucket.

Retrieves a specific historical revision of a HubSpot workflow.

Retrieves a list of workflow summaries (ID, name, type, status) from HubSpot, using the 'limit' parameter for pagination.

Lists one page from HubSpot's complete legacy aggregate engagement feed.

Lists assets of a specific `assetType` for a given HubSpot marketing `campaignGuid`, optionally including performance metrics for a date range.

Lists one page of legacy engagements associated with a contact or company.

Return v4 association labels for a directed pair of CRM object types.

Lists all valid association types between two specified HubSpot CRM object types.

Lists Enterprise-only HubSpot account audit logs with optional filters and pagination.

Lists HubSpot v4 automation flows with forward pagination.

Lists HubSpot CMS blog posts with documented filters and cursor pagination.

Return HubSpot call disposition IDs and labels.

Retrieves a paginated list of HubSpot companies.

List all activity/engagement associations from a company to a specified activity type (calls, emails, meetings, notes, or tasks). Returns the IDs of associated engagement records. Use this action when you need to retrieve all activities of a specific type for a company to build a timeline or activity history.

Lists all calls associated with a specific HubSpot company. Returns call IDs and their association types with the company. Use this action when you need to retrieve all call activity records linked to a company without fetching full call details. For full call properties, use the returned call IDs with a call read action.

List all meetings associated with a specific company in HubSpot. Returns meeting IDs and association metadata for meetings linked to the company record. Use this action when you need to retrieve all meetings scheduled with or related to a particular company.

List all notes associated with a specific HubSpot contact. Returns note IDs and association metadata. Use this action when you need to retrieve all notes linked to a contact record. To get full note details (body, timestamp, etc.), use the note IDs with a batch read action.

Lists 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

Retrieves a paginated list of HubSpot contacts.

List all tasks associated with a specific contact. Returns task IDs and association metadata for tasks linked to the given contact. Use this action when you need to retrieve all tasks related to a contact, such as viewing pending action items or following up on contact-related to-dos.

Returns one offset-controlled page of HubSpot content templates.

Lists HubSpot conversation channels with sorting and pagination.

Lists HubSpot conversation inbox resources with cursor pagination.

Lists HubSpot conversation threads with filtering and forward pagination.

Retrieves activities (notes, calls, emails, meetings, tasks) associated with a specific HubSpot deal. Use this action when you need to view the complete activity timeline for a deal, including all engagement types. This provides a comprehensive view of interactions and communications related to the deal, which is useful for understanding deal history and next steps.

List all meetings associated with a specific deal in HubSpot. Returns meeting IDs and association metadata. Use this action when you need to retrieve meetings linked to a deal without fetching full meeting details. This is useful for understanding deal activity, tracking customer interactions, or building reports of engagement touchpoints.

Retrieves a paginated list of HubSpot deals.

Return one cursor-controlled page of connected HubSpot CMS domains.

Lists one paginated page of HubSpot email campaign IDs.

Lists email-analytics campaign IDs ordered by recent activity.

Lists one page of HubSpot marketing email events; continue with `offset` only while `hasMore` is true.

Retrieves a paginated list of HubSpot emails, allowing selection of specific properties (with or without history), associated object IDs, and filtering by archive status.

Retrieves all event templates associated with a valid `appId` for an existing application in HubSpot's CRM Timeline.

Retrieves a paginated list of feedback submissions from HubSpot, allowing specification of properties (including history), associated object IDs, and filtering by archive status.

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

Lists historical revisions of a HubSpot landing page.

Return one cursor-controlled page of HubSpot landing pages.

Lists HubSpot account login attempts.

List all associations from a single CRM record to a specified target object type. Use when you need to expand associations for a single record without fetching the full CRM object.

Retrieves a paginated list of HubSpot products.

Retrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object IDs, and filtering by archived status.

Lists one page of engagements from HubSpot's last-30-days or 10,000-most-recently-updated feed.

Lists automation sequences for a specific HubSpot user.

Lists HubSpot account users and their provisioning details.

Return one cursor-controlled page of HubSpot website pages.

Lists HubSpot teams and their primary and secondary user memberships.

Retrieves a paginated list of HubSpot tickets.

Lists user roles available in the connected HubSpot account.

Translates a legacy HubSpot list ID to its current list ID.

Merges two existing company records of the same type in HubSpot CRM, where `objectIdToMerge` is absorbed into `primaryObjectId`; this operation is irreversible.

Merges two HubSpot contacts into one.

Merges two HubSpot deals into one.

Merges two HubSpot emails into one.

Merges two existing feedback submissions by ID, primarily for consolidating duplicates or related feedback; this operation is irreversible, and `primaryObjectId` values take precedence in conflicts.

Merges two line items, `objectIdToMerge` into `primaryObjectId`, which must be of the same type; `objectIdToMerge` is absorbed and the operation is irreversible.

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

Merges two HubSpot products into one.

Merges two distinct quotes of the same type by consolidating `objectIdToMerge` into `primaryObjectId` (e.g., for combining information or updating terms); this operation is irreversible.

Merges two HubSpot tickets into one.

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

Permanently deletes a HubSpot contact and all its associated data for GDPR compliance, identifying the contact by its ID or another unique property.

Publishes or sends a specified HubSpot marketing email that is valid and ready for sending; requires Marketing Hub Enterprise or the transactional email add-on.

Apply draft changes to the live version of an already published HubSpot site page.

Reads a specific CRM property definition for a given HubSpot object type by its internal name.

Retrieves definitions and metadata (not actual values) for properties of a specified HubSpot CRM object type (e.g., 'contacts', 'companies', 'deals', or custom objects).

Retrieves a paginated list of objects for a specified and valid HubSpot CRM object type (e.g., 'contacts', 'companies', 'deals', or custom ID).

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

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

Retrieves up to 100 feedback submissions in a batch using their IDs or a specified unique `idProperty`, optionally including specified properties and their history.

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

Retrieves a batch of HubSpot CRM line items by their IDs, or optionally by values of a custom unique property defined in `idProperty`.

Efficiently retrieves a batch of HubSpot CRM quotes by their IDs (or a specified unique property), optionally including archived quotes, specific properties, and property history.

Fetches detailed budget (total, spent, remaining) and spend information for a marketing campaign, including an 'order' field for sequencing budget/spend items (0 is oldest).

Retrieves a HubSpot contact by its ID.

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

Retrieves a specific CRM object (e.g., contact, company, deal, ticket) by its ID or a unique property, optionally including specific properties, history, and associations.

Call this to retrieve an existing HubSpot email by its `emailId` or an alternative unique `idProperty`.

Reads a HubSpot feedback submission by its ID, optionally using a custom unique 'idProperty', and allows specifying properties to return including history and associations.

Retrieve one legacy HubSpot contact profile by VID when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.

Batch-read up to 100 legacy HubSpot contact profiles by email when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.

Batch-read up to 100 legacy HubSpot contact profiles by VID when legacy-shaped profile data is needed.

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

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

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

Tool to remove all associations between two CRM records using the v4 associations endpoint. Use when unlinking records or cleaning up incorrect associations.

Permanently removes a specified association definition (type) from a HubSpot object's schema, preventing future creations of this association type without affecting existing instances.

Remove one secondary email address from a HubSpot contact.

Removes a HubSpot deal by its ID.

Remove a provisioned HubSpot account user by user ID or email.

Removes a token from a HubSpot event template, preventing its inclusion in new events created from that template.

Renames an existing HubSpot CRM list.

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

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

Overwrites an entire CRM pipeline (specified by `objectType` and `pipelineId`) and all its stages with a new definition, returning the updated pipeline.

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

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

Restores a specific revision of a marketing email to a DRAFT state, overwriting any existing draft.

Restores a specific, existing, non-active revision of a marketing email to become the new live version for that email.

Retrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas.

Retrieves all pipelines in HubSpot for a specified CRM object type, such as deals or tickets.

Retrieves the read-only calling extension settings for a specific HubSpot app; the app must exist and have calling extensions configured.

Retrieves a HubSpot CRM line item by its ID or a specified unique property (`idProperty`).

Fetches a paginated list of HubSpot CRM line items, allowing selection of specific properties (including history), associated object IDs, and filtering by archive status; ensure property and association names are valid HubSpot internal names.

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

Retrieves a specific HubSpot CRM owner by their ID, with options to specify ID type (owner or user) and to include archived records.

Retrieves a list of all owners in the HubSpot CRM, including their ID, first name, last name, email, and user ID.

Retrieves a paginated list of CRM owners from HubSpot, optionally filtering by email or archived status.

Fetches detailed properties and metadata (e.g., label, display order, custom properties) for a specific stage within a HubSpot CRM pipeline, identified by its `objectType`, `pipelineId`, and `stageId`.

Fetches all stages for a specified HubSpot CRM object type and pipeline ID.

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

Retrieves video conference application settings, such as webhook URLs and user/account management configurations, for a specified `appId`.

Schedules a HubSpot landing page to publish at a specified date and time.

Searches for HubSpot campaigns.

Searches for HubSpot companies using flexible criteria and filters.

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

Searches and pages through HubSpot CRM list definitions.

Searches HubSpot CRM objects (e.g., 'contacts', 'companies') by `objectType` using complex criteria including filters, sorting, and pagination; property names used in filters, sorts, and returned properties must be valid for the specified `objectType`.

Searches for HubSpot deals using flexible criteria and filters.

Searches for HubSpot emails using flexible criteria and filters.

Searches for feedback submissions in HubSpot CRM using text query, filter groups, sorting, and pagination, returning specified properties.

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

Searches for HubSpot products using flexible criteria and filters.

Searches HubSpot CRM quotes using a text query, complex filter criteria, sorting, and pagination.

Searches for HubSpot tickets using flexible criteria and filters.

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

Call this action to start an asynchronous data import into HubSpot CRM using uploaded files and a detailed `importRequest` JSON configuration, ensuring this JSON correctly maps file columns to HubSpot properties and files align with these mappings.

Updates properties of an existing marketing email identified by its `emailId`; unspecified fields retain their current values.

Updates a batch of HubSpot feedback submissions; property keys must be existing internal HubSpot names and values must be correctly formatted strings.

Performs a batch update on a valid `objectType` where properties are writeable and any `idProperty` used is designated unique; updates can be partial.

Updates the recording settings, such as the URL for retrieving authenticated recordings, for a specific calling extension app identified by its `appId`.

Updates settings (e.g., display name, UI URL/dimensions, feature flags) for an existing calling extension app, identified by `appId`.

Partially updates specific, writable properties of an existing HubSpot marketing campaign identified by `campaignGuid`; an empty string value in `properties` clears a property.

Updates properties for up to 50 existing HubSpot marketing campaigns in a single batch operation.

Updates multiple HubSpot companies in a single batch operation.

Updates properties for an existing HubSpot company.

Updates properties for an existing HubSpot contact.

Updates multiple HubSpot contacts in a single batch operation.

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

Updates properties for an existing HubSpot deal.

Updates multiple HubSpot deals in a single batch operation.

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

Updates multiple HubSpot emails in a single batch operation.

IRREVERSIBLY opt out or update email subscription preferences in HubSpot.

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

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

Sparse-update a HubSpot landing page and return its updated state.

Partially update a HubSpot landing page draft without publishing it.

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

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

Replace dynamic-list filters and optionally enroll newly matching records.

Adds records to or removes records from a manual or snapshot CRM list.

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

Partially updates a CRM pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`.

Partially updates a HubSpot CRM pipeline stage identified by `objectType`, `pipelineId`, and `stageId`, requiring `metadata` in the request; unspecified fields are unchanged.

Updates properties for an existing HubSpot product.

Updates multiple HubSpot products in a single batch operation.

Partially updates a property group's `displayOrder` or `label` for a specified CRM `objectType` in HubSpot.

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

Updates properties for an existing HubSpot ticket.

Updates multiple HubSpot tickets in a single batch operation.

Updates the label or options of an existing token within a specified HubSpot CRM event template; token name and data type remain unchanged.

Updates webhook URLs (for creating/updating/deleting meetings, fetching accounts, verifying users) for a video conference application specified by `appId`. Requires developer API key authentication. All URLs must use HTTPS protocol and be publicly accessible.

Fully replace an existing Automation v4 workflow at its current revision.

Creates or updates as many as 100 HubSpot companies by unique property value.

Creates or updates as many as 100 HubSpot contacts by unique property value.

Return the connected HubSpot account (portal id, domain). HubSpot identity is account-level, not per-user.

Add one or more gifts (donations) to an existing gift batch in Blackbaud Raiser's Edge NXT. Use this tool when you need to: - Append new gifts to an open batch for later processing - Batch multiple donations together before committing them - Add gifts with detailed information (payments, splits, custom fields) Prerequisites: - The batch must already exist (use a create batch action first if needed) - The batch must be in "open" status (not committed) - You need the batch_id (system record ID) and constituent_id (donor ID) for each gift Note: This action returns response details for all HTTP status codes (including errors). Check the status_code field in the response to determine success (200) vs errors (4xx/5xx).

Retrieves comprehensive gift details from Blackbaud Raiser's Edge NXT by gift ID. Use this tool when you need to fetch detailed information about a specific gift including: - Gift amount and currency - Donor/constituent information - Gift type and status - Important dates (gift date, post date) - Associated metadata and custom fields The gift_id is the unique system record ID (integer) that identifies the gift in Raiser's Edge NXT.

Retrieves comprehensive membership details from Blackbaud Raiser's Edge NXT by member junction ID. Fetches detailed information about a specific membership including program name, category/subcategory, membership status and standing (Active, Lapsed), start/expiration dates, dues information, and associated constituent ID. Requires a valid member_junction_id (GUID) that uniquely identifies a membership junction record linking a constituent to a membership program in Raiser's Edge NXT. Returns error information in the response object for graceful error handling in agent workflows.

Retrieves payment transaction details from Blackbaud SKY Payments API. Use this to check transaction status, amounts, payment methods, and error details. Transaction IDs come from payment processing endpoints, checkout callbacks, batch operations, or webhook notifications. Requires: Payments API subscription key (Bb-Api-Subscription-Key) and OAuth Bearer token. This retrieves existing transactions; it does not process new payments.

Tool to interact with Blackbaud OneRoster OAuth2 base endpoints. Use to fetch OpenID configuration (/.well-known/openid-configuration), JWKS key set (publickeys), or obtain an access token via the client credentials grant. Ensure client credentials are configured before using the token operation.

Tool to get brand details by brand ID. Use after obtaining the brand identifier.

Tool to list all brands in the account. Use after confirming account is authenticated.

Tool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.

Tool to edit an existing custom field. Use when you need to update a custom field's properties after creation.

Tool to list documents sent on behalf of users. Use when fetching and filtering documents you've sent or on behalf of others.

Tool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.

Tool to extend a document's expiry date. Use before signing to prolong a document's deadline.

Tool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.

Tool to remove authentication from a document. Use when you need to disable signer authentication on an existing document before the signing process.

Tool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.

Tool to list team documents. Use when a team or account admin needs to retrieve all team documents with optional filters.

Tool to create an embedded request link. Use after specifying title and signers to generate an embeddable URL for in-app document preparation and sending.

Helper action to upload a file to R2 temp via the Xava file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).

Tool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.

Tool to attach a file from a provided URL to a task. The file will be downloaded and attached asynchronously. Use when you need to add a file attachment to a task from a URL source.

Tool to create a new comment on a DART task. Use when you need to add feedback, notes, or discussion to a specific task. Supports markdown formatting and threaded replies via parentId.

Tool to add a time tracking entry to a DART task. Use when you need to record time spent on a specific task. The finishedAt timestamp must be after startedAt.

Tool to create a new doc in Dart. Use when you need to record a new document that the user intends to write down. By default, the created doc will be in the Docs folder unless a specific folder is specified.

Tool to create a new task in DART with title and optional metadata. Use when you need to add a task to a workspace.

Tool to move an existing doc to the trash where it can be recovered if needed. Use when you need to delete a doc without permanently removing it.

Tool to delete an existing task in Dart by moving it to trash. Use when a task needs to be removed but can be recovered later.

Tool to retrieve workspace configuration including dartboards, folders, types, statuses, and more. Use when you need to understand available options in the workspace.

Tool to retrieve an existing doc with metadata and content. Use when you need to access a specific document's details including title, folder, and text content.

Tool to retrieve an existing task with full details including title, dartboard, status, and description. Use when you need to fetch complete information about a specific task.

Tool to list comments for a task with filtering options. Use when you need to retrieve comments on a specific task. Supports filtering by author, text content, date range, and pagination. Can be ordered by date or hierarchical thread structure.

Tool to list docs with filtering and search capabilities. Use when you need to retrieve documents from DART with filters like folder, title, text content, or full-text search. Supports pagination and custom ordering by creation date, update date, or title.

Tool to search help center articles by semantic similarity to query. Use when you need to find relevant help articles based on a short search query (1-5 words). Returns up to two most relevant articles.

Tool to list tasks with powerful filtering options. Use when you need to retrieve tasks from DART with filters like dartboard, status, assignee, tags, priority, dates, or completion state. Supports pagination and custom ordering.

Tool to move a task to a specific position within its dartboard. Use when you need to reorder tasks in a list. Specify either afterTaskId or beforeTaskId to position the task.

Tool to retrieve a skill by its exact title from the workspace. Use when you need to find details about a specific skill including its ID and instructions.

Tool to update an existing doc in Dart. Use when you need to modify a document's title, folder location, or content. Any properties not specified will remain unchanged.

Tool to update an existing task in DART with new properties. Use when you need to modify a task's title, status, assignees, or other attributes. Only properties specified in the request will be updated.