# HubSpot docs: APIs Legacy ## Legacy - [Legacy API reference](https://developers.hubspot.com/docs/api-reference/legacy/overview.md): Reference documentation for HubSpot's legacy numeric-versioned APIs (v1–v4). - [Legacy API migration guide](https://developers.hubspot.com/docs/api-reference/legacy/migration-guide.md): Learn how to audit usage of legacy APIs and migrate to the latest date-based endpoints. - [APIs / Legacy / CMS (257 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/cms.md): Documentation for APIs / Legacy / CMS. - [APIs / Legacy / CRM (735 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/crm.md): Documentation for APIs / Legacy / CRM. ### Account & Settings #### Account information - [Account information API](https://developers.hubspot.com/docs/api-reference/legacy/account/account-information/guide.md): HubSpot's account information API endpoints provide account configuration and usage data. - [Retrieve account details](https://developers.hubspot.com/docs/api-reference/legacy/account/account-information/get-account-details.md): Retrieve account details such as the account type, time zone, currencies, and data hosting location. - [Retrieve private app daily API usage](https://developers.hubspot.com/docs/api-reference/legacy/account/account-information/get-usage-details.md): Retrieve the daily API usage for private apps in the account, along with information about usage limits. ##### v1 - [Get details for a HubSpot account](https://developers.hubspot.com/docs/api-reference/legacy/account/account-information/v1/get-integrations-v1-me.md): This endpoint uses an API key or access token to get details for a HubSpot account. Returns the Portal ID (often called the Hub ID), time zone setting, and selected currency of the account. #### Audit Logs - [Account activity API](https://developers.hubspot.com/docs/api-reference/legacy/account/audit-logs/guide.md): Learn more about the account activity API endpoints. - [Retrieve audit logs](https://developers.hubspot.com/docs/api-reference/legacy/account/audit-logs/get-audit-logs.md): Retrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-i… - [Retrieve login activity](https://developers.hubspot.com/docs/api-reference/legacy/account/audit-logs/get-login.md): Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history). - [Retrieve security history](https://developers.hubspot.com/docs/api-reference/legacy/account/audit-logs/get-security.md): Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history). #### Brands - [Brands API](https://developers.hubspot.com/docs/api-reference/legacy/account/brands/guide.md): HubSpot's brands API endpoint provides information about brands tied to a user. - [Retrieve brands by associated user](https://developers.hubspot.com/docs/api-reference/legacy/account/brands/get-brands.md): Retrieve the brands that a specific user can access. #### Settings ##### Multicurrency - [Settings API | Currencies](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/guide.md): Learn more about the currencies API endpoints to view and update your account's currencies and exchange rates. ###### Batch - [Create multiple exchange rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/batch/create-exchange-rates.md): Create multiple exchange rates in a single request. - [Retrieve multiple rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/batch/get-exchange-rates.md): Retrieve the details of multiple exchange rates in a single request, specified by their IDs. - [Update multiple exchange rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/batch/update-exchange-rates.md): Update the conversion rates for multiple exchange rates in a batch operation. ###### Central FX Rates - [Add a new currency with central exchange rates.](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/central-fx-rates/create-multicurrency.md): Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here. - [Retrieve information about the central exchange rates feature.](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/central-fx-rates/get-exchange-rates.md): Retrieve details on whether the central exchange rates feature is enabled for the portal. - [Retrieve currencies not supported by central exchange rates.](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/central-fx-rates/get-unsupported-currencies.md): Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated. ###### Currency - [Get the company currency](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/currency/get-company-currency.md): Get the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals. - [Get all currency codes](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/currency/get-currency-codes.md): Retrieve a list of all available currency codes and their names. - [Set or update the company currency.](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/currency/update-company-currency.md): Set or update the primary company currency. ###### Exchange rates - [Add a new exchange rate](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/create-exchange-rate.md): Create a new exchange rate with specified conversion rate and currency codes. - [Change the visibility of a specific currency pairs](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/create-update-visibility.md): Change the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app. - [Get all current exchange rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/get-current-exchange-rates.md): Retrieve all current exchange rates for all currency pairs. - [Get the details for a specific exchange rate](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/get-exchange-rate.md): Retrieve the details for a specific exchange rate specified by its ID. - [Get exchange rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/get-exchange-rates.md): Get a list of exchange rates - [Update a conversion rate](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/multicurrency/exchange-rates/update-exchange-rate.md): Update an existing conversion rate, specified by its ID. ##### Tax Rates - [Get a specific tax rate](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/tax-rates/get-tax-rate.md): Retrieve a specific tax rate by its `taxRateGroupId`. - [Get all tax rates](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/tax-rates/get-tax-rates.md): Retrieve a paginated list of all tax rates set up in the account tax rate library ##### User Provisioning - [Settings API | User Provisioning](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/guide.md): The user provisioning endpoints allow you to provision and deprovision HubSpot users programatically. - [Query CRM object user permissions](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/public-permissions.md): View the CRM permissions set for users in a given account. ###### Roles - [Retrieves the roles on an account](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/roles/get-roles.md): Retrieves the roles on an account ###### Teams - [See details about this account's teams](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/teams/get-teams.md): View teams for this account ###### Users - [Adds a user](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/users/create-user.md) - [Retrieves a user](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/users/get-user.md): Retrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. - [Retrieves a list of users from an account](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/users/get-users.md) - [Modifies a user](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/users/update-user.md): Modifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. - [Removes a user](https://developers.hubspot.com/docs/api-reference/legacy/account/settings/user-provisioning/users/delete-user.md): Removes a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. ### App Management #### App Uninstalls - [Uninstall app](https://developers.hubspot.com/docs/api-reference/legacy/app-management/app-uninstalls/uninstall-app.md): Use this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account. #### Feature Flags - [Feature flags](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/guide.md): Learn how to use the feature flags API to streamline migration from legacy CRM cards. ##### Flags - [Retrieve an app's feature flags](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/flags/get-feature-flags.md) - [Set an app's feature flag](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/flags/update-feature-flag.md): Set a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs. - [Delete an app's feature flag](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/flags/delete-feature-flag.md): Delete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated. ##### Portal Flag States - [Retrieve account flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/get-account-flag.md): Retrieve the account-level flag state of a specific HubSpot account. - [Retrieve accounts with a set flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/get-accounts-with-flag-state.md): Retrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included. - [Set an account flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/update-account-flag.md): Specify an account-level flag state for a specific HubSpot account. - [Batch set account flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/upsert-account-flag.md): Set the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts. - [Batch delete account flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/delete-portal-flag-batch.md): Delete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts. - [Delete an account flag state](https://developers.hubspot.com/docs/api-reference/legacy/app-management/feature-flags/portal-flag-states/delete-portal-flag.md): Delete an account-level flag state for a specific HubSpot account. No request body is included. ### Authentication - [Manage OAuth access tokens using the v3 APIs](https://developers.hubspot.com/docs/api-reference/legacy/authentication/manage-oauth-tokens.md): Learn how to use the new v3 OAuth endpoints to manage access and refresh tokens to securely perform CRUD actions with HubSpot APIs. #### OAuth tokens - [OAuth token endpoint](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/create-oauth-token.md): Authenticates a client and returns access and refresh tokens. - [Token introspection endpoint](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/token-introspect.md): Returns validity and metadata for access and refresh tokens. ##### v1 - [Manage OAuth access tokens using the v1 APIs](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/guide.md): Get OAuth access and refresh tokens using the older v1 API endpoints. - [Migrate from the OAuth v1 API to the latest date-based versioned API](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/migration-guide.md): Learn how to migrate from the v1 OAuth API endpoints to the latest endpoints with stronger security. - [Retrieve OAuth token metadata](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/get-oauth-token-metadata.md) - [Retrieve refresh token metadata](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/get-refresh-token-metadata.md) - [Refresh an access token](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/refresh-oauth-token.md): Authenticates a client and returns access and refresh tokens. - [Delete a refresh token](https://developers.hubspot.com/docs/api-reference/legacy/authentication/oauth-tokens/v1/delete-refresh-token.md) ### Automation #### Sequences - [Sequences API](https://developers.hubspot.com/docs/api-reference/legacy/automation/sequences/guide.md): Learn how to use the v4 automation API for sequences. - [Enroll a contact into a sequence](https://developers.hubspot.com/docs/api-reference/legacy/automation/sequences/enroll-contact.md): Enroll a contact into a sequence using the specified user ID and sequence details. - [Retrieve a contact's enrollment status](https://developers.hubspot.com/docs/api-reference/legacy/automation/sequences/get-enrollment.md): Get the enrollment status of a contact in sequences by their contact ID. - [Retrieve a sequence](https://developers.hubspot.com/docs/api-reference/legacy/automation/sequences/get-sequence.md): Retrieve details of a specific sequence by its ID. - [Retrieve sequences](https://developers.hubspot.com/docs/api-reference/legacy/automation/sequences/get-sequences.md) #### Workflow actions - [Create custom workflow actions with the action builder](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/custom-action-builder.md): Use HubSpot's in-app custom action builder to build custom workflow actions. - [Build custom workflow actions](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/custom-action-guide.md): An introduction and overview of workflow extensions. - [Custom workflow actions reference](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/custom-action-reference.md): Reference information for creating custom workflow actions. - [Workflows | Custom Code Actions](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/custom-code-actions.md): Instructions for using custom code actions in workflows ##### Callbacks - [Complete a batch of callbacks](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/callbacks/batch-complete-callbacks.md): Complete a batch of blocked action executions. - [Complete a callback](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/callbacks/complete-callback.md): Complete a specific blocked action execution by ID. ##### Definitions - [Create a new custom action definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/create-action-definition.md): Create a new custom workflow action. - [Retrieve a custom action definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/get-action-definition.md): Retrieve a custom workflow action definition by ID. - [Retrieve custom action definitions](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/get-action-definitions.md): Retrieve custom workflow action definitions by app ID. - [Set the object requirement for a custom action definition.](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/set-object-requirement.md): Set whether a custom action definition requires an object. - [Update an existing action definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/update-action-definition.md): Update an existing action definition by ID. - [Delete an action definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/definitions/delete-action-definition.md): Delete an action definition by ID. ##### Functions - [Insert a function for a definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/add-function.md): Add a function for a given definition. - [Archive a function for a definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/archive-function.md): Archive a function for a specific definition. - [Retrieve a function from a given definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/get-function.md): Retrieve a specific function from a given definition. - [Retrieve functions by a type for a given definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/get-functions-by-type.md): Retrieve functions of a specific type for a given definition. - [Retrieve functions for a given definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/get-functions.md): Retrieve all functions included in a definition. - [Update a function for a definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/update-function.md): Update a function for a given definition by ID. - [Delete a function for a definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/functions/delete-function.md): Delete a function within a given definition. ##### Revisions - [Retrieve a specific revision of a definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/revisions/get-revision.md): Retrieve a specific revision of a definition by revision ID. - [Retrieve revisions for a given definition](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflow-actions/revisions/get-revisions.md): Retrieve the versions of a definition by ID. #### Workflows - [Workflows API](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/guide.md): Learn how to use the workflows v4 API. - [Workflow actions and enrollment types](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/action-enrollment-reference.md): Review the different action and enrollment event types for the v4 automation API. - [Create a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/create-workflow.md): Create a new automation flow by providing the necessary details in the request body. - [Retrieve workflow email campaigns](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/get-email-campaigns.md): Retrieve a list of email campaigns associated with automation flows, with optional pagination using 'after', 'before', and 'limit' query parameters. - [Retrieve a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/get-workflow.md): Retrieve the details of a specific automation flow using its unique flow ID. - [Retrieve workflows](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/get-workflows.md): Retrieve a list of automation flows with optional pagination using the 'after' and 'limit' query parameters. - [Update a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/update-workflow.md): Update the details of an existing automation flow by providing the necessary information in the request body. - [Delete a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/delete-workflow.md): Delete an automation flow identified by its flow ID. ##### Batch - [Retrieve workflow ID mappings](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/batch/get-workflow-id-mappings.md): Retrieve mappings between flow IDs and workflow IDs in batch, allowing for efficient management of ID relationships. - [Retrieve workflows](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/batch/get-workflows.md): Retrieve details of multiple automation flows by providing a batch of flow IDs in the request body. This endpoint allows for efficient retrieval of multiple flows at once, returning their details in a single response. ##### v3 - [Create a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v3/create-workflow.md): Create a new workflow with the supplied JSON body. - [Get workflow performance](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v3/get-workflow-performance.md): Get performance statistics for a workflow over a specified time range. - [Get a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v3/get-workflow.md): Returns metadata for a specific workflow, including starting conditions and steps. - [Get all workflows](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v3/get-workflows.md): Retrieve a list of workflows (metadata only). - [Delete a workflow](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v3/delete-workflow.md): Delete the specified workflow. ##### v2 - [Enroll contact](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v2/enroll-contact.md): Enroll a contact (email) into workflowId. - [Get current enrollment](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v2/get-current-enrollment.md): List workflows a contact (by vid) is currently enrolled in. - [Unenroll contact](https://developers.hubspot.com/docs/api-reference/legacy/automation/workflows/v2/unenroll-contact.md): Remove a contact from workflow. ### Communication preferences - [API guide](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/guide.md): The v4 subscription preferences endpoints allow you to manage email subscriptions details for contacts in your account. - [Generate preference page URLs](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/generate-url-guide.md): Generate preference page URLs to allow marketing email recipients to manage their subscription preferences. #### Definitions - [Retrieve all subscription status definitions](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/definitions/get-subscription-definitions.md): Get a list of subscription status definitions from the account. #### Status - [Generate subscription links](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/generate-link.md): Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, which are useful for integrating communication preferences into your applications. Learn more about [generating preference page URLs and troubleshooting poten… - [Get subscription preferences for a specific contact](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/get-subscription.md): Retrieve a contact's current email subscription preferences. - [Retrieve a contact's unsubscribed status](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/get-unsubscribed-status.md): Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty. - [Unsubscribe a contact from all subscriptions](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/unsubscribe-contact.md): Unsubscribe a contact from all email subscriptions. ##### Batch - [Batch retrieve subscription statuses](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/batch/get-subscriptions.md): Retrieve the communication preferences statuses for a batch of subscribers. This endpoint allows you to check the subscription status across a specified channel for multiple subscribers at once. It is useful for managing and auditing subscriber preferences in bulk. - [Batch retrieve contacts who have opted out of all communications](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/batch/get-unsubscribed-batch.md): Retrieve the unsubscribe-all status for a batch of subscribers across specified channels. This endpoint is useful for checking the unsubscribe status of multiple subscribers in bulk, particularly for email channels. - [Batch unsubscribe contacts from all subscriptions](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/batch/unsubscribe-contacts-batch.md): Unsubscribe a set of contacts from all email subscriptions. - [Batch update subscription status](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/status/batch/update-subscription-status-batch.md): Update the subscription status for a set of contacts. #### v3 - [Subscriptions preferences v3](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v3/guide.md): Use the subscriptions preferences API to manage email subscription details for your contacts. - [Get subscription definitions](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v3/get-subscription-definitions.md): Get a list of subscription status definitions from the account. - [Get subscription statuses for a contact](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v3/get-subscription.md) - [Subscribe a contact](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v3/subscribe-contact.md) - [Unsubscribe a contact](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v3/unsubscribe-contact.md) #### v1 - [Get email subscription types for a Hub ID](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v1/get-subscription-types.md): Returns all email subscription types that have been created in the given Hub ID. - [Get email subscription status for an email address](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v1/get-subscriptions-email.md): For a given portal, return the email subscription information for the given email address and portal. For specific email subscription types, if the value is true or false, the definition will be returned. - [View subscriptions timeline for a portal](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v1/get-subscriptions-timeline.md): For a given portal, return a time-ordered list of subscription changes. Timeline items will be returned in reverse-chronological order. - [Update email subscription status for an email address](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/v1/update-subscription.md): Use this endpoint to update an email address' email type subscription status or permanently unsubscribe an email address from all email. Note: If you OPT OUT of all emails or a specific email subscription type for a recipient, there is NO UNDO for this operation. ### Conversations - [Conversations API](https://developers.hubspot.com/docs/api-reference/legacy/conversations/guide.md): Use the conversations API to manage inboxes, channels, threads, and messages. #### Conversations ##### Actors - [Get a single actor](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/actors/get-actor.md): Retrieve details of a single actor using the actor ID. - [Get a group of actors](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/actors/get-actors.md): Resolve a set of `ActorId`s to the underlying actors/participants. ##### Channel accounts - [Get a single channel account](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/channel-accounts/get-conversation.md): Retrieve details of a single channel account using the channel account ID. - [Get channel accounts](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/channel-accounts/get-conversations.md): Retrieve a list of channel accounts, with optional filters and sorting. ##### Channels - [Get a single channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/channels/get-conversation.md): Retrieve details of a single channel using the channel ID. - [Get channels](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/channels/get-conversations.md): Retrieve a list of channels, with optional filters and sorting. ##### Inboxes - [Get a single conversations inbox](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/inboxes/get-conversation.md): Retrieve details of a single conversations inbox using the inbox ID. - [Get conversations inboxes](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/inboxes/get-conversations.md): Retrieve a list of conversations inboxes, with optional filters and sorting. ##### Messages - [Get a single message](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/messages/get-conversation.md): Retrieve a single message from a thread using the message ID. - [Get the original content of a single message](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/messages/get-conversations.md): Returns the complete original text and rich text bodies of a message. This will be different from the text and rich text in the message itself if the message's `truncationStatus` is anything other than `NOT_TRUNCATED`. ##### Threads - [Send a message to a thread](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/create-conversation.md): Send a new message on a thread at the current timestamp. - [Get a single thread](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/get-conversation.md): Retrieve a single thread by its ID - [Get message history for a thread](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/get-conversations-threadId.md): Retrieve the message history for a specific thread. - [Get threads](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/get-conversations.md): Retrieve a list of threads, with optional filters and sorting. - [Update a thread](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/update-conversation.md): Updates a single thread. Either a thread's status can be updated, or the thread can be restored. - [Archives a thread](https://developers.hubspot.com/docs/api-reference/legacy/conversations/conversations/threads/delete-conversation.md): Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state. #### Custom Channels - [Custom channels API guide (v3)](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/guide.md): Learn how to use the v3 custom channel API for the conversations inbox and help desk. ##### Channel accounts - [Create a channel account](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channel-accounts/create-custom-channel.md): Create a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers. - [Get accounts for a channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channel-accounts/get-custom-channels.md): Retrieve a list of accounts for a custom channel. - [Update a channel account](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channel-accounts/update-custom-channel-channelAccountId.md): This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account. - [Update a channel account staging token](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channel-accounts/update-custom-channel.md): Update a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token. This is used for public apps. ##### Channels - [Create a custom channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/create-custom-channel.md) - [Get a channel account by id](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/get-custom-channel-channelAccountId.md): Retrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information. - [Get a custom channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/get-custom-channel.md): Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata - [Get all channels for app](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/get-custom-channels.md) - [Update a custom channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/update-custom-channel.md): Update the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl. - [Archive a custom channel](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/channels/delete-custom-channel.md): Archive an existing registered custom channel ##### Messages - [Publish a message](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/messages/create-custom-channel.md): Publish a message over your custom channel - [Get a message](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/messages/get-custom-channel.md): Get the details for a specific message sent over a custom channel - [Update a message ](https://developers.hubspot.com/docs/api-reference/legacy/conversations/custom-channels/messages/update-custom-channel.md): Update a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure. #### Visitor identification - [Visitor Identification](https://developers.hubspot.com/docs/api-reference/legacy/conversations/visitor-identification/guide.md): The visitor identification API is used to identify visitors to your site that were authenticated using external authentication systems. - [Generate a visitor identification token](https://developers.hubspot.com/docs/api-reference/legacy/conversations/visitor-identification/generate-visitor-token.md): Generate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This… ### Events - [Events API | Events](https://developers.hubspot.com/docs/api-reference/legacy/events/guide.md): Event endpoints help you find and filter events and event occurrences linked to CRM records. #### Define events - [Define custom events](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/guide.md): Learn more about creating custom events using HubSpot's API. - [Create custom event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/create-event-definition.md): Create a custom event definition. - [Create a property for an event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/create-event-property.md): Create a new property for an existing event definition. - [Retrieve a custom event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/get-event-definition.md): Fetch a single custom event definition by name. - [Retrieve event definitions](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/get-event-definitions.md): Retrieve existing custom event definitions. - [Update a custom event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/update-event-definition.md): Update a specific custom event definition by name. - [Update an existing custom event property](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/update-event-property.md): Update an existing property in a custom event definition. - [Delete an event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/delete-event-definition.md): Delete a custom event definition by name. - [Delete a property from a custom event definition](https://developers.hubspot.com/docs/api-reference/legacy/events/define-events/delete-event-property.md): Delete an existing property from a custom event definition. #### Retrieve events - [Retrieve event types](https://developers.hubspot.com/docs/api-reference/legacy/events/retrieve-events/get-event-types.md) - [Retrieve event occurrences](https://developers.hubspot.com/docs/api-reference/legacy/events/retrieve-events/get-events.md) #### Send event data - [Send custom event occurrences](https://developers.hubspot.com/docs/api-reference/legacy/events/send-event-data/guide.md): Custom events allow you to track advanced activity via a JavaScript or HTTP API. The Events API can be used to get details about your events. - [Send a batch of event occurrences](https://developers.hubspot.com/docs/api-reference/legacy/events/send-event-data/batch-send-occurrences.md): Send multiple event occurrences at once. - [Send a custom event occurrence](https://developers.hubspot.com/docs/api-reference/legacy/events/send-event-data/send-event-occurrence.md): Send data for a single custom event occurrence. ### Files - [Files API](https://developers.hubspot.com/docs/api-reference/legacy/files/guide.md): Learn how to upload and manage files in your HubSpot account using the files API. #### Files - [Retrieve file by ID](https://developers.hubspot.com/docs/api-reference/legacy/files/files/get-file-fileId.md): Retrieve a file by its ID. - [Retrieve file by path](https://developers.hubspot.com/docs/api-reference/legacy/files/files/get-file-filePath.md): Retrieve a file by its path. - [Check import status](https://developers.hubspot.com/docs/api-reference/legacy/files/files/get-file-status.md): Check the status of requested import. - [Get signed URL to access private file](https://developers.hubspot.com/docs/api-reference/legacy/files/files/get-signed-url.md): Generates signed URL that allows temporary access to a private file. - [Import file from URL](https://developers.hubspot.com/docs/api-reference/legacy/files/files/import-from-url.md): Asynchronously imports the file at the given URL into the file manager. - [Replace file](https://developers.hubspot.com/docs/api-reference/legacy/files/files/replace-file.md): Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references. - [Search files](https://developers.hubspot.com/docs/api-reference/legacy/files/files/search-files.md): Search through files in the file manager. Does not display hidden or archived files. - [Update file properties](https://developers.hubspot.com/docs/api-reference/legacy/files/files/update-file.md): Update properties of file by ID. - [Upload file](https://developers.hubspot.com/docs/api-reference/legacy/files/files/upload-file.md): Upload a single file with content specified in request body. - [Delete file by ID](https://developers.hubspot.com/docs/api-reference/legacy/files/files/delete-file.md): Delete a file by ID #### Folders - [Create folder](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/create-folder.md): Creates a folder. - [Retrieve folder by path](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/get-folder-folderPath.md): Retrieve a folder, identified by its path. - [Check folder update status](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/get-folder-update-status.md): Check status of folder update. Folder updates happen asynchronously. - [Retrieve folder by ID](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/get-folder.md): Retrieve a folder by its ID. - [Search folders](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/search-folders.md): Search for folders. Does not contain hidden or archived folders. - [Update folder properties by folder ID](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/update-folder-folderId.md): Update a folder's properties, identified by folder ID. - [Update folder properties](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/update-folder.md): Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well. - [Delete folder by path](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/delete-folder-folderPath.md): Delete a folder, identified by its path. - [Delete folder by ID](https://developers.hubspot.com/docs/api-reference/legacy/files/folders/delete-folder.md): Delete folder by ID. ### Marketing #### Campaigns - [Campaigns API](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/guide.md): Endpoints for managing your HubSpot campaigns - [Create a campaign](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/create-campaign.md) - [Retrieve a campaign](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/get-campaign.md): Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are avai… - [Search campaigns](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/get-campaigns.md) - [Update a campaign](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/update-campaign.md): Perform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error. If an empty string is passed for any property in the Batch Update, it will reset that property's value. - [Delete a campaign](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/delete-campaign.md): Delete a specified campaign from the system. This call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not. ##### Assets - [Add asset](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/assets/add-asset.md): Associate a specified asset with a campaign. Using the API, you can create associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing… - [Retrieve assets](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/assets/get-assets.md): This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type. Asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided. - [Disassociate asset](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/assets/delete-asset.md): Disassociate a specified asset from a campaign. Using the API, you can remove associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, market… ##### Batch - [Create campaigns](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/batch/create-campaigns.md): This endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request. - [Get campaigns](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/batch/get-campaigns.md): This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request… - [Update campaigns](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/batch/update-campaigns.md): This endpoint updates a batch of campaigns based on the provided input data. The maximum number of items in a batch request is 50. If an empty string ("") is passed for any property in the Batch Update, it will reset that property's value. - [Delete campaigns](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/batch/delete-campaigns.md): This endpoint deletes a batch of campaigns. The maximum number of items in a batch request is 50. The response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted. ##### Budget - [Add budget item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/budget/create-budget-item.md): Add a new budget item to the campaign - [Retrieve budget item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/budget/get-budget-item.md): Get a specific budget item by ID - [Retrieve budget totals](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/budget/get-budget-totals.md): Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget. Budget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0… - [Update budget item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/budget/update-budget-item.md): Update a specific budget item by ID - [Delete budget item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/budget/delete-budget-item.md): Delete a specific budget item by ID ##### Reports - [Get contact IDs](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/reports/get-contact-ids.md): Fetch the list of contact IDs for the specified campaign and contact type - [Get revenue](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/reports/get-revenue.md): Fetch revenue attribution report data for a specified campaign ##### Spend - [Create a spend item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/spend/create-spend-item.md): Create a new campaign spend item - [Retrieve a spend item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/spend/get-spend-item.md): Read a campaign spend item by its spendId - [Update a spend item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/spend/update-spend-item.md): Update a specific campaign spend item by ID - [Delete a spend item](https://developers.hubspot.com/docs/api-reference/legacy/marketing/campaigns/spend/delete-spend-item.md): Delete a specific campaign spend item by ID #### Forms - [Forms ](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/guide.md): These endpoints are used to create and manage forms in your HubSpot account. - [Create a form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/create-form.md) - [Get a form definition](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/get-form.md): Returns a form based on the form ID provided. - [Get a list of forms](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/get-forms.md) - [Partially update a form definition](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/update-form-formId.md): Update some of the form definition components - [Update a form definition](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/update-form.md): Update all fields of a hubspot form definition. - [Archive a form definition](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/delete-form.md): Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months. ##### v3 legacy - [Submit data to a form (supporting authentication)](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v3-legacy/submit-data-authenticated.md): Send form submission data to a HubSpot form, specified by form ID. This endpoint requires authentication and has higher rate limits. - [Submit data to a form (unauthenticated)](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v3-legacy/submit-data-unauthenticated.md): Send form submission data to a HubSpot form, specified by form ID. This endpoint supports cross-origin (CORS) AJAX requests. ##### v2 ###### Fields - [Get a single field from a form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/fields/get-forms-v2-fields-form_guid-field_name.md): For a given portal, return a form field that has been created on a particular form in a portal. - [Get all fields from a form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/fields/get-forms-v2-fields-form_guid.md): Retrieve all fields that have been created for a specific form. ###### Forms - [Get a form by its unique ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/forms/get-forms-v2-forms-form_guid.md): For a given account, return a single form based on the unique ID of that form. - [Get all forms from an account](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/forms/get-forms-v2-forms.md): This endpoint is used to return all forms that have been created in an account. Forms are standard tools that can be used to generate website leads. - [Create a new form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/forms/post-forms-v2-forms.md): This endpoint is used to create a new form in a given HubSpot account. - [Update an existing form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/forms/put-forms-v2-forms-form_guid.md): Update an existing form in a specified HubSpot portal. - [Delete an existing form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v2/forms/delete-forms-v2-forms-form_guid.md): For a given portal, delete an existing form in a given HubSpot portal. ##### v1 - [Get submissions for a form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v1/get-form-integrations-v1-submissions-forms-form_guid.md): Get the submissions for the specified form. This will include the fields in the submissions, the time of the form submission, and the page URL that the form was submitted on. Submissions will be returned in reverse-chronological order. - [Get a file uploaded via form](https://developers.hubspot.com/docs/api-reference/legacy/marketing/forms/v1/get-form-integrations-v1-uploaded-files-signed-url-redirect-fileId.md): For a given file id, return the file associated with that Id. The initial GET on this URL returns a redirect, which should be followed to retrieve the file. #### Marketing Emails - [Marketing API | Marketing Email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/guide.md): Learn how to create, update, and retrieve data for your emails using the Marketing Emails v3 API. - [Unpublish or cancel a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/cancel-email.md): If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible. - [Create an A/B test variation](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/create-ab-variation.md): Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created. - [Clone a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/create-clone.md): This will create a duplicate email with the same properties as the original, with the exception of a unique ID. - [Create a new marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/create-email.md) - [Get the details of a specified marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/get-email.md): Get the details for a marketing email. - [Get all marketing emails](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/get-emails.md) - [Update a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/update-email.md): Change properties of a marketing email. - [Delete a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/delete-email.md): Delete a marketing email by its ID ##### Revisions - [Get a revision of a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/revisions/get-revision.md): Get a specific revision of a marketing email. - [Get revisions of a marketing email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/revisions/get-revisions.md): Get a list of all versions of a marketing email, with each entry including the full state of that particular version. To view the most recent version, sort by the updatedAt parameter. - [Restore to draft](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/revisions/reset-to-draft.md): Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. - [Update draft](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/revisions/update-draft.md): Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned. ##### Statistics - [Get statistics histogram](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/statistics/get-histogram.md): Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time. - [Get aggregated statistics](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-emails/statistics/get-statistics.md): Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span. #### Marketing Events - [Marketing events API guide](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/guide.md): An overview of the Marketing Events object in HubSpot. - [Create an event](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/create-event.md): Creates a new marketing event in HubSpot - [Retrieve event by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/get-marketing-event-objectId.md): Returns the details of a Marketing Event with the specified objectId, if it exists. - [Retrieve event by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/get-marketing-event.md): Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. - [Retrieve all events](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/get-marketing-events.md) - [Partially update event by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/update-event-externalId.md): Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. - [Update event by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/update-event.md): Updates the details of an existing Marketing Event identified by its objectId, if it exists. - [Update event by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/update-marketing-event.md): Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created. - [Delete event by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/delete-event-externalId.md): Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. - [Delete event by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/delete-event.md): Deletes the existing Marketing Event with the specified objectId, if it exists. ##### Attendance - [Record attendance by contact ID and external event ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/attendance/set-attendance-contactId-externalId.md): Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. - [Record attendance by contact ID and HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/attendance/set-attendance-contactId.md): Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. - [Record attendance by participant email and external event ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/attendance/set-attendance-email-externalId.md): Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. - [Record attendance by participant email and HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/attendance/set-attendance-email.md): Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. ##### Batch - [Update events by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/batch/update-marketing-events.md): Updates multiple Marketing Events on the portal based on their objectId, if they exist. - [Create or update events](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/batch/upsert-marketing-events.md): Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created. - [Delete events by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/batch/delete-events-externalId.md): Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId. - [Delete events by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/batch/delete-marketing-events.md): Deletes multiple Marketing Events from the portal based on their objectId, if they exist. ##### Event Status - [Mark an event as canceled](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/event-status/set-event-canceled.md): Mark a marketing event as cancelled. - [Mark an event as complete](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/event-status/set-event-complete.md): Mark a marketing event as completed ##### Identifiers - [Get events by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/identifiers/get-marketing-events-externalId.md): This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. - [Search for events by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/identifiers/search-events.md): Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. ##### List Associations - [Associate a list by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/associate-list-externalId.md): Associates a list with a marketing event by external account id, external event id, and ILS list id - [Associate a list by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/associate-list.md): Associates a list with a marketing event by marketing event id and ILS list id - [Get associated lists by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/get-events-marketingEventId.md): Gets lists associated with a marketing event by marketing event id - [Get associated lists by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/get-lists-externalId.md): Gets lists associated with a marketing event by external account id and external event id - [Remove a list from an event by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/remove-list-externalId.md): Disassociates a list from a marketing event by external account id, external event id, and ILS list id - [Remove a list from an event](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/list-associations/remove-list.md): Disassociates a list from a marketing event by marketing event id and ILS list id ##### Participant State - [Retrieve participant breakdown by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/participant-state/get-breakdown-externalId.md): Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. - [Retrieve participant breakdown by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/participant-state/get-breakdown.md): Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId. - [Retrieve participants by contact identifier](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/participant-state/get-participants-contactId.md): Read Contact's participations by identifier - email or internal id. - [Retrieve participants by external ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/participant-state/get-participants-externalId.md): Read Marketing event's participations counters by externalAccountId and externalEventId pair. - [Retrieve participants by HubSpot ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/participant-state/get-participants.md): Read Marketing event's participations counters by internal identifier marketingEventId. ##### Settings - [Retrieve the application settings](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/settings/get-app-settings.md): Retrieve the current settings for the application. - [Update the application settings](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/settings/update-app-settings.md): Create or update the current settings for the application. ##### Subscriber State Changes - [Set subscriber state by contact ID](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/subscriber-state-changes/set-subscriber-state-contactId.md): Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created. - [Record a subscriber state by contact email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/subscriber-state-changes/set-subscriber-state.md): Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update… ##### v1 - [Events HTTP API](https://developers.hubspot.com/docs/api-reference/legacy/marketing/marketing-events/v1/trigger-event.md): Trigger a custom behavioral event using an HTTP GET request. Event completions can be tracked in HubSpot and used to segment contacts, score leads, and more. If you have an EU portal you must use the tracking server track-eu1.hubspot.com. #### Single Send - [Marketing API | Single send API](https://developers.hubspot.com/docs/api-reference/legacy/marketing/single-send/guide.md): An overview of the marketing single-send API in HubSpot. - [Send an email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/single-send/create-single-send.md): Send a template email to a specific recipient. #### Transactional Emails - [Transactional email API guide](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/guide.md): An overview of the transactional email feature in HubSpot. - [Send a transactional email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/create-transactional-email.md): Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API. ##### SMTP Tokens - [Reset the password of an existing token.](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/smtp-tokens/create-transactional-single-send-tokenId.md): Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid. - [Create a SMTP API token.](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/smtp-tokens/create-transactional-single-send.md): Create a SMTP API token. - [Query a single token by ID.](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/smtp-tokens/get-transactional-single-send-tokenId.md): Query a single token by ID. - [Query SMTP API tokens by campaign name or an emailCampaignId.](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/smtp-tokens/get-transactional-single-send.md): Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId. - [Delete a single token by ID.](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/smtp-tokens/delete-transactional-single-send.md): Delete a single token by ID. ##### v1 - [List SMTP API Tokens](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/v1/get-email-public-v1-smtpapi-tokens.md): List SMTP API tokens which can then be used to send email through HubSpot's SMTP API. Note that this API will not return passwords. Passwords are only returned during token creation, and during password reset. - [Send a single transactional email](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/v1/post-email-public-v1-singleEmail-send.md): This method is used to send an email designed in the marketing email tool. After you design and publish a transactional email in your HubSpot account, you can use this API to include customization options to the email, then send it to the intended recipient. - [SMTP API Tokens - Password Reset](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/v1/post-email-public-v1-smtpapi-tokens-userName-password-reset.md): This endpoint allows for the creation of a replacement password for a given Token, keyed by the userName field. Once the password is successfully reset, the old password for the token will be invalid. - [Create SMTP API Tokens](https://developers.hubspot.com/docs/api-reference/legacy/marketing/transactional-emails/v1/post-email-public-v1-smtpapi-tokens.md): This endpoint is used to create an SMTP API Token. An API token provides both a username and password which can then be used to send email through the HubSpot SMTP API. ### Reporting #### Email Analytics - [Email Events API Overview](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/guide.md): Learn more about the Email Events API endpoints. ##### Campaigns - [Get all campaign IDs for an account](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/campaigns/get-email-public-v1-campaigns-by-id.md): Return all email campaign IDs associated with the HubSpot account. The email campaign IDs are returned in no particular order. - [Get campaign data for a given campaign](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/campaigns/get-email-public-v1-campaigns-campaign_id.md): This endpoint provides a way to query data associated with a given email campaign. - [Get campaign IDs with recent activity for an account](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/campaigns/get-email-public-v1-campaigns.md): Return all campaign IDs sorted by recent activity associated with the HubSpot account. The campaign IDs are returned in descending order of most-recent activity. ##### Events - [Get Email Event By ID](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/events/get-email-public-v1-events-created-id.md): Query the event log for a specific event and get results for that email event. - [Get email events](https://developers.hubspot.com/docs/api-reference/legacy/reporting/email-analytics/events/get-email-public-v1-events.md): This endpoint is used to query the event log for events matching specified parameters. #### Event definitions - [Get Event by ID](https://developers.hubspot.com/docs/api-reference/legacy/reporting/event-definitions/get-event-definition.md): Given an event ID, returns a specific event definition in a given portal. - [Get a Group of Events by ID](https://developers.hubspot.com/docs/api-reference/legacy/reporting/event-definitions/get-event-definitions-batch.md): Given a batch of event IDs, returns a list of event definitions in a given portal. - [Get events](https://developers.hubspot.com/docs/api-reference/legacy/reporting/event-definitions/get-event-definitions.md): This endpoint is used to get data for all events in a HubSpot account with a Marketing Hub Enterprise subscription. #### Reports - [Get analytics data breakdowns](https://developers.hubspot.com/docs/api-reference/legacy/reporting/reports/get-analytics-v2-reports-breakdown_by-time_period.md): This endpoint is used to get analytics data for a specified category. - [Get data for HubSpot hosted content](https://developers.hubspot.com/docs/api-reference/legacy/reporting/reports/get-analytics-v2-reports-content_type-time_period.md): Get analytics data for your HubSpot hosted content. - [Get analytics data for specific objects](https://developers.hubspot.com/docs/api-reference/legacy/reporting/reports/get-analytics-v2-reports-object_type-time_period.md): Get analytics data for specific objects, based on the type of object. - [Check for the existence of analytics data for an object type](https://developers.hubspot.com/docs/api-reference/legacy/reporting/reports/get-analytics-v2-reports-objectType-exists.md): Check to see if there is analytics data for a specified object type. - [Get all analytics views](https://developers.hubspot.com/docs/api-reference/legacy/reporting/reports/get-analytics-views.md): Get the details for the analytics views set up in the portal. ### Scheduler - [Library | Meetings](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/guide.md): Use the meetings API to retrieve information about meetings created through a scheduling page. You can also book a meeting with a scheduling page through the API. #### Calendar - [Create a new calendar event for a meeting](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/calendar/create-calendar-event.md): Create a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone. #### Meetings - [Book a meeting](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/meetings/create-meeting.md): Book a meeting for a specified meeting page. - [Retrieve meeting availability](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/meetings/get-availability.md): Get the next availability times for a meeting page. - [Retrieve meeting scheduling pages](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/meetings/get-meeting-links.md): Get a paged list meeting scheduling pages - [Retrieve meeting link slug](https://developers.hubspot.com/docs/api-reference/legacy/scheduler/meetings/get-meeting-slug.md): Get details about the initial information necessary for a meeting scheduler. ### Webhooks - [Webhooks v3 API guide](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/guide.md): Overview for the v3 Webhooks API, which allows you to subscribe to events happening in a HubSpot account with your integration installed. - [Webhooks journal and management APIs (BETA)](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/webhooks-journal.md): Learn how to use the new webhooks journal and v4 management APIs. #### Settings - [Read webhook settings](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/settings/get-setting.md): Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date. - [Update webhook setting](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/settings/update-setting.md): Update webhook settings for the specified app. - [Delete webhook settings](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/settings/delete-setting.md): Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created. #### Subscriptions - [Create an event subscription](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/create-subscription.md): Create new event subscription for the specified app. - [Batch create event subscriptions](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/create-subscriptions.md): Batch create event subscriptions for the specified app. - [Read an event subscription](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/get-subscription.md): Retrieve a specific event subscription by ID. - [Read event subscriptions](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/get-subscriptions.md): Retrieve event subscriptions for the specified app. - [Update an event subscription](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/update-subscription.md): Update an existing event subscription by ID. - [Delete event subscription](https://developers.hubspot.com/docs/api-reference/legacy/webhooks/subscriptions/delete-subscription.md): Delete an existing event subscription by ID. ## OpenAPI Specs - [account-account-info-v3](/docs/specs/legacy/v3/account-account-info-v3.json) - [account-activity-v1](/docs/specs/legacy/v1/account-activity-v1.json) - [account-audit-logs-v3](/docs/specs/legacy/v3/account-audit-logs-v3.json) - [business-units-business-units-v3](/docs/specs/legacy/v3/business-units-business-units-v3.json) - [settings-multicurrency-v3](/docs/specs/legacy/v3/settings-multicurrency-v3.json) - [settings-tax-rates-v1](/docs/specs/legacy/v1/settings-tax-rates-v1.json) - [settings-user-provisioning-v3](/docs/specs/legacy/v3/settings-user-provisioning-v3.json) - [crm-app-uninstalls-v3](/docs/specs/legacy/v3/crm-app-uninstalls-v3.json) - [crm-public-app-feature-flags-v3-v3](/docs/specs/legacy/v3/crm-public-app-feature-flags-v3-v3.json) - [auth-oauth-v3](/docs/specs/legacy/v3/auth-oauth-v3.json) - [auth-oauth-v1](/docs/specs/legacy/v1/auth-oauth-v1.json) - [automation-sequences-v4](/docs/specs/legacy/v4/automation-sequences-v4.json) - [automation-actions-v4-v4](/docs/specs/legacy/v4/automation-actions-v4-v4.json) - [automation-automation-v4-v4](/docs/specs/legacy/v4/automation-automation-v4-v4.json) - [create-manage-workflows-v3](/docs/specs/legacy/v3/create-manage-workflows-v3.json) - [create-manage-workflows-v2](/docs/specs/legacy/v2/create-manage-workflows-v2.json) - [cms-authors-v3](/docs/specs/legacy/v3/cms-authors-v3.json) - [cms-blog-settings-v3](/docs/specs/legacy/v3/cms-blog-settings-v3.json) - [blog-details-v2](/docs/specs/legacy/v2/blog-details-v2.json) - [blog-comments-v3](/docs/specs/legacy/v3/blog-comments-v3.json) - [cms-posts-v3](/docs/specs/legacy/v3/cms-posts-v3.json) - [blog-posts-v2](/docs/specs/legacy/v2/blog-posts-v2.json) - [cms-tags-v3](/docs/specs/legacy/v3/cms-tags-v3.json) - [blog-topics-v3](/docs/specs/legacy/v3/blog-topics-v3.json) - [cms-cms-content-audit-v3](/docs/specs/legacy/v3/cms-cms-content-audit-v3.json) - [cms-domains-v3](/docs/specs/legacy/v3/cms-domains-v3.json) - [domains-v1](/docs/specs/legacy/v1/domains-v1.json) - [cms-hubdb-v3](/docs/specs/legacy/v3/cms-hubdb-v3.json) - [modules-v4](/docs/specs/legacy/v4/modules-v4.json) - [cms-media-bridge-v1](/docs/specs/legacy/v1/cms-media-bridge-v1.json) - [cms-pages-v3](/docs/specs/legacy/v3/cms-pages-v3.json) - [pages-v2](/docs/specs/legacy/v2/pages-v2.json) - [cms-site-search-v3](/docs/specs/legacy/v3/cms-site-search-v3.json) - [site-search-v2](/docs/specs/legacy/v2/site-search-v2.json) - [cms-source-code-v3](/docs/specs/legacy/v3/cms-source-code-v3.json) - [cms-url-mappings-v3](/docs/specs/legacy/v3/cms-url-mappings-v3.json) - [cms-url-redirects-v3](/docs/specs/legacy/v3/cms-url-redirects-v3.json) - [communication-preferences-subscriptions-v4](/docs/specs/legacy/v4/communication-preferences-subscriptions-v4.json) - [communication-preferences-subscriptions-v3](/docs/specs/legacy/v3/communication-preferences-subscriptions-v3.json) - [marketing-subscriptions-v1](/docs/specs/legacy/v1/marketing-subscriptions-v1.json) - [conversations-conversations-v3](/docs/specs/legacy/v3/conversations-conversations-v3.json) - [conversations-custom-channels-v3](/docs/specs/legacy/v3/conversations-custom-channels-v3.json) - [conversations-visitor-identification-v3](/docs/specs/legacy/v3/conversations-visitor-identification-v3.json) - [crm-calls-v3](/docs/specs/legacy/v3/crm-calls-v3.json) - [crm-emails-v3](/docs/specs/legacy/v3/crm-emails-v3.json) - [crm-meetings-v3](/docs/specs/legacy/v3/crm-meetings-v3.json) - [crm-notes-v3](/docs/specs/legacy/v3/crm-notes-v3.json) - [crm-postal-mail-v3](/docs/specs/legacy/v3/crm-postal-mail-v3.json) - [crm-tasks-v3](/docs/specs/legacy/v3/crm-tasks-v3.json) - [crm-engagements-v1](/docs/specs/legacy/v1/crm-engagements-v1.json) - [crm-associations-v4](/docs/specs/legacy/v4/crm-associations-v4.json) - [crm-associations-schema-v4](/docs/specs/legacy/v4/crm-associations-schema-v4.json) - [crm-associations-schema-v3](/docs/specs/legacy/v3/crm-associations-schema-v3.json) - [crm-associations-v3](/docs/specs/legacy/v3/crm-associations-v3.json) - [crm-associations-v1](/docs/specs/legacy/v1/crm-associations-v1.json) - [crm-exports-v3](/docs/specs/legacy/v3/crm-exports-v3.json) - [crm-calling-extensions-v3](/docs/specs/legacy/v3/crm-calling-extensions-v3.json) - [crm-public-app-crm-cards-v3](/docs/specs/legacy/v3/crm-public-app-crm-cards-v3.json) - [crm-timeline-v3](/docs/specs/legacy/v3/crm-timeline-v3.json) - [crm-timeline-v1](/docs/specs/legacy/v1/crm-timeline-v1.json) - [crm-transcriptions-v3](/docs/specs/legacy/v3/crm-transcriptions-v3.json) - [crm-video-conferencing-extension-v3](/docs/specs/legacy/v3/crm-video-conferencing-extension-v3.json) - [crm-extensions-v1](/docs/specs/legacy/v1/crm-extensions-v1.json) - [crm-imports-v3](/docs/specs/legacy/v3/crm-imports-v3.json) - [crm-limits-tracking-v3](/docs/specs/legacy/v3/crm-limits-tracking-v3.json) - [crm-lists-v3](/docs/specs/legacy/v3/crm-lists-v3.json) - [crm-appointments-v3](/docs/specs/legacy/v3/crm-appointments-v3.json) - [crm-carts-v3](/docs/specs/legacy/v3/crm-carts-v3.json) - [crm-commerce-payments-v3](/docs/specs/legacy/v3/crm-commerce-payments-v3.json) - [crm-commerce-subscriptions-v3](/docs/specs/legacy/v3/crm-commerce-subscriptions-v3.json) - [crm-communications-v3](/docs/specs/legacy/v3/crm-communications-v3.json) - [crm-companies-v3](/docs/specs/legacy/v3/crm-companies-v3.json) - [crm-companies-v2](/docs/specs/legacy/v2/crm-companies-v2.json) - [crm-companies-v1](/docs/specs/legacy/v1/crm-companies-v1.json) - [crm-contacts-v3](/docs/specs/legacy/v3/crm-contacts-v3.json) - [crm-contacts-v1](/docs/specs/legacy/v1/crm-contacts-v1.json) - [crm-contracts-v3](/docs/specs/legacy/v3/crm-contracts-v3.json) - [crm-courses-v3](/docs/specs/legacy/v3/crm-courses-v3.json) - [crm-custom-objects-v3](/docs/specs/legacy/v3/crm-custom-objects-v3.json) - [crm-deal-splits-v3](/docs/specs/legacy/v3/crm-deal-splits-v3.json) - [crm-deals-v3](/docs/specs/legacy/v3/crm-deals-v3.json) - [crm-deals-v1](/docs/specs/legacy/v1/crm-deals-v1.json) - [crm-discounts-v3](/docs/specs/legacy/v3/crm-discounts-v3.json) - [crm-feedback-submissions-v3](/docs/specs/legacy/v3/crm-feedback-submissions-v3.json) - [crm-fees-v3](/docs/specs/legacy/v3/crm-fees-v3.json) - [crm-forecasts-v3](/docs/specs/legacy/v3/crm-forecasts-v3.json) - [crm-forecast-types-v3](/docs/specs/legacy/v3/crm-forecast-types-v3.json) - [crm-goal-targets-v3](/docs/specs/legacy/v3/crm-goal-targets-v3.json) - [crm-invoices-v3](/docs/specs/legacy/v3/crm-invoices-v3.json) - [crm-leads-v3](/docs/specs/legacy/v3/crm-leads-v3.json) - [crm-line-items-v3](/docs/specs/legacy/v3/crm-line-items-v3.json) - [crm-line-items-v1](/docs/specs/legacy/v1/crm-line-items-v1.json) - [crm-listings-v3](/docs/specs/legacy/v3/crm-listings-v3.json) - [crm-object-library-v3](/docs/specs/legacy/v3/crm-object-library-v3.json) - [crm-objects-v3](/docs/specs/legacy/v3/crm-objects-v3.json) - [crm-orders-v3](/docs/specs/legacy/v3/crm-orders-v3.json) - [crm-partner-clients-v3](/docs/specs/legacy/v3/crm-partner-clients-v3.json) - [crm-partner-services-v3](/docs/specs/legacy/v3/crm-partner-services-v3.json) - [crm-products-v3](/docs/specs/legacy/v3/crm-products-v3.json) - [crm-products-v1](/docs/specs/legacy/v1/crm-products-v1.json) - [crm-projects-v3](/docs/specs/legacy/v3/crm-projects-v3.json) - [crm-quotes-v3](/docs/specs/legacy/v3/crm-quotes-v3.json) - [crm-schemas-v3](/docs/specs/legacy/v3/crm-schemas-v3.json) - [crm-services-v3](/docs/specs/legacy/v3/crm-services-v3.json) - [crm-taxes-v3](/docs/specs/legacy/v3/crm-taxes-v3.json) - [crm-tickets-v3](/docs/specs/legacy/v3/crm-tickets-v3.json) - [crm-tickets-v1](/docs/specs/legacy/v1/crm-tickets-v1.json) - [crm-users-v3](/docs/specs/legacy/v3/crm-users-v3.json) - [crm-crm-owners-v3](/docs/specs/legacy/v3/crm-crm-owners-v3.json) - [crm-owners-v2](/docs/specs/legacy/v2/crm-owners-v2.json) - [crm-pipelines-v3](/docs/specs/legacy/v3/crm-pipelines-v3.json) - [crm-pipelines-v1](/docs/specs/legacy/v1/crm-pipelines-v1.json) - [crm-properties-v3](/docs/specs/legacy/v3/crm-properties-v3.json) - [crm-properties-v2](/docs/specs/legacy/v2/crm-properties-v2.json) - [crm-properties-v1-companies](/docs/specs/legacy/v1/crm-properties-v1-companies.json) - [crm-properties-v1-contacts](/docs/specs/legacy/v1/crm-properties-v1-contacts.json) - [crm-properties-v1-deals](/docs/specs/legacy/v1/crm-properties-v1-deals.json) - [crm-property-validations-v3](/docs/specs/legacy/v3/crm-property-validations-v3.json) - [events-manage-event-definitions-v3](/docs/specs/legacy/v3/events-manage-event-definitions-v3.json) - [events-events-v3](/docs/specs/legacy/v3/events-events-v3.json) - [events-send-event-completions-v3](/docs/specs/legacy/v3/events-send-event-completions-v3.json) - [files-files-v3](/docs/specs/legacy/v3/files-files-v3.json) - [marketing-campaigns-public-api-v3](/docs/specs/legacy/v3/marketing-campaigns-public-api-v3.json) - [marketing-forms-v3](/docs/specs/legacy/v3/marketing-forms-v3.json) - [forms-v3-legacy](/docs/specs/legacy/v3/forms-v3-legacy.json) - [forms-v2](/docs/specs/legacy/v2/forms-v2.json) - [forms-v1](/docs/specs/legacy/v1/forms-v1.json) - [marketing-marketing-emails-v3](/docs/specs/legacy/v3/marketing-marketing-emails-v3.json) - [marketing-marketing-events-v3](/docs/specs/legacy/v3/marketing-marketing-events-v3.json) - [marketing-events-tracking-v1](/docs/specs/legacy/v1/marketing-events-tracking-v1.json) - [marketing-single-send-v4](/docs/specs/legacy/v4/marketing-single-send-v4.json) - [marketing-transactional-single-send-v3](/docs/specs/legacy/v3/marketing-transactional-single-send-v3.json) - [transactional-emails-v1](/docs/specs/legacy/v1/transactional-emails-v1.json) - [email-analytics-v1](/docs/specs/legacy/v1/email-analytics-v1.json) - [reporting-v2](/docs/specs/legacy/v2/reporting-v2.json) - [scheduler-meetings-v3](/docs/specs/legacy/v3/scheduler-meetings-v3.json) - [webhooks-webhooks-v3](/docs/specs/legacy/v3/webhooks-webhooks-v3.json)