HubSpot

DESTRUCTIVE. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls DELETE /conversations/conversations/v3/threads/{threadId}/assignee on api.hubapi.com. Requires the HubSpot scope conversations.write.

DESTRUCTIVE. Archives a thread. Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls DELETE /conversations/v3/conversations/threads/{threadId} on api.hubapi.com. Requires the HubSpot scope conversations.write.

DESTRUCTIVE. Delete association label. Remove a specific label from the association between two CRM object types. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls DELETE /crm/associations/v4/{fromObjectType}/{toObjectType}/labels/{associationTypeId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Delete the schema of a specified custom object. Remove a custom object schema from the account using its object type ID or fully qualified name. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls DELETE /crm-object-schemas/v3/schemas/{objectType} on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.write.

DESTRUCTIVE. Delete an existing association for a specified object type. Remove an association between two object types identified by the association identifier and object type. This operation is irreversible and will permanently delete the specified association. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls DELETE /crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier} on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.write.

DESTRUCTIVE. Recurring Commerce Hub subscriptions. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Delete a subscription. Delete a specific subscription by its ID. Recurring Commerce Hub subscriptions. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/objects/2026-03/subscriptions/{subscriptionId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{projectId}` to the recycling bin. Projects are the Service Hub project object. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/objects/v3/projects/{projectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

DESTRUCTIVE. Call transcription records and their text. Calls DELETE /crm/v3/extensions/calling/transcripts/{transcriptId} on api.hubapi.com. Requires the HubSpot scope crm.extensions_calling_transcripts.write.

DESTRUCTIVE. Delete a List. Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls DELETE /crm/v3/lists/{listId} on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Delete All Records from a List. Remove **all** of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. This endpoint only supports lists that have less than 100,000 memberships. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls DELETE /crm/v3/lists/{listId}/memberships on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Cancel the conversion of a list. Delete an existing scheduled conversion for a list. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls DELETE /crm/v3/lists/{listId}/schedule-conversion on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Deletes a folder. Deletes the folder with the given Id. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls DELETE /crm/v3/lists/folders/{folderId} on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Archive. Move an Object identified by `{serviceId}` to the recycling bin. Services are the service object type. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/0-162/{serviceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

DESTRUCTIVE. Archive. Move an Object identified by `{dealId}` to the recycling bin. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/0-3/{dealId} on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

DESTRUCTIVE. Archive. Move an Object identified by `{courseId}` to the recycling bin. Courses are the education object type. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/0-410/{courseId} on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

DESTRUCTIVE. Archive. Move an Object identified by `{listingId}` to the recycling bin. Listings are the real-estate object type. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/0-420/{listingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

DESTRUCTIVE. Archive. Move an Object identified by `{objectId}` to the recycling bin. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/{objectType}/{objectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Archive. Move an Object identified by `{callId}` to the recycling bin. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/calls/{callId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Delete a cart. Move an Object identified by `{cartId}` to the recycling bin. Carts are the Commerce Hub basket object. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/carts/{cartId} on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{commercePaymentId}` to the recycling bin. Payments recorded against invoices, subscriptions and payment links. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/commerce_payments/{commercePaymentId} on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

DESTRUCTIVE. Archive. Move an Object identified by `{communicationId}` to the recycling bin. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/communications/{communicationId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a company. Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records). Companies are the organisations contacts belong to. A company id is what associates a deal with an account. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/companies/{companyId} on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

DESTRUCTIVE. Archive a contact. Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/contacts/{contactId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{discountId}` to the recycling bin. Discounts applied to quotes, invoices and orders. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/discounts/{discountId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive. Move an Object identified by `{emailId}` to the recycling bin. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{feeId}` to the recycling bin. Fees applied to quotes, invoices and orders. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/fees/{feeId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Delete a goal target. Move an Object identified by `{goalTargetId}` to the recycling bin. Goal targets are the per-owner sales targets Sales Hub reports against. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/goal_targets/{goalTargetId} on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

DESTRUCTIVE. Archive. Move an Object identified by `{invoiceId}` to the recycling bin. Invoices are the Commerce Hub billing document. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/invoices/{invoiceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

DESTRUCTIVE. Archive. Move an Object identified by `{leadsId}` to the recycling bin. Leads are the Sales Hub prospecting object that sits in front of a contact. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/leads/{leadsId} on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

DESTRUCTIVE. Archive. Move an Object identified by `{lineItemId}` to the recycling bin. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/line_items/{lineItemId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive. Move an Object identified by `{meetingId}` to the recycling bin. Meeting engagements on a record's timeline. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/meetings/{meetingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{noteId}` to the recycling bin. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/notes/{noteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{orderId}` to the recycling bin. Orders are the Commerce Hub order object. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/orders/{orderId} on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

DESTRUCTIVE. Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/postal_mail/{postalMailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{productId}` to the recycling bin. Products are the product library entries line items are created from. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/products/{productId} on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

DESTRUCTIVE. Archive. Move an Object identified by `{quoteId}` to the recycling bin. Quotes are the customer-facing priced document generated from a deal and its line items. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/quotes/{quoteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

DESTRUCTIVE. Archive. Move an Object identified by `{taskId}` to the recycling bin. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/tasks/{taskId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive. Move an Object identified by `{taxId}` to the recycling bin. Taxes applied to quotes, invoices and orders. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/taxes/{taxId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive. Move an Object identified by `{ticketId}` to the recycling bin. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/tickets/{ticketId} on api.hubapi.com. Requires the HubSpot scope tickets.

DESTRUCTIVE. Archive. Move an Object identified by `{userId}` to the recycling bin. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v3/objects/users/{userId} on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

DESTRUCTIVE. Delete a pipeline. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls DELETE /crm/v3/pipelines/{objectType}/{pipelineId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Delete a pipeline stage. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls DELETE /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Archive a property. Move a property identified by {propertyName} to the recycling bin. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls DELETE /crm/v3/properties/{objectType}/{propertyName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Archive a property group. Move a property group identified by {groupName} to the recycling bin. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls DELETE /crm/v3/properties/{objectType}/groups/{groupName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Delete associations between two records. deletes all associations between two records. Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. HubSpot's delete on a CRM object is an ARCHIVE: the record leaves every view and every list, and a HubSpot admin can restore it from the portal's recycle bin for 90 days. After 90 days it is gone. HubSpot publishes no un-archive endpoint, so the restore is a HubSpot UI action, not an Agentic Fabriq one. Calls DELETE /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Delete file by ID. Delete a file by ID The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls DELETE /files/v3/files/{fileId} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

DESTRUCTIVE. GDPR-delete file. Delete a file in accordance with GDPR regulations. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. There is NO undo and no recovery. This is not the ordinary file delete: it erases the file and its stored copies to satisfy a GDPR erasure request, and nothing restores it. Prefer the ordinary file delete unless a subject-erasure request is the reason for the call. Requires confirm="erase-this-file-permanently" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls DELETE /files/v3/files/{fileId}/gdpr-delete on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

DESTRUCTIVE. Delete folder by ID. Delete folder by ID. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls DELETE /files/v3/folders/{folderId} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

DESTRUCTIVE. Delete folder by path. Delete a folder, identified by its path. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls DELETE /files/v3/folders/{folderPath} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

DESTRUCTIVE. Delete campaign. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls DELETE /marketing/v3/campaigns/{campaignGuid} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

DESTRUCTIVE. Remove asset association. 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, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows. For other asset types, it is recommended to manage your... Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls DELETE /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

DESTRUCTIVE. Delete budget item. Delete a specific budget item by ID Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls DELETE /marketing/v3/campaigns/{campaignGuid}/budget/{budgetId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

DESTRUCTIVE. Delete campaign spend item. Delete a specific campaign spend item by ID Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls DELETE /marketing/v3/campaigns/{campaignGuid}/spend/{spendId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

DESTRUCTIVE. Delete a marketing email. Delete a marketing email by its ID Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls DELETE /marketing/v3/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

DESTRUCTIVE. Archive a form definition. Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months. Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls DELETE /marketing/v3/forms/{formId} on api.hubapi.com. Requires the HubSpot scope forms.

DESTRUCTIVE. Disassociate a list from a marketing event. Disassociates a list from a marketing event by external account id, external event id, and ILS list id Marketing events - webinars and similar - and their attendance state. Calls DELETE /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

DESTRUCTIVE. Disassociate a list from a marketing event. Disassociates a list from a marketing event by marketing event id and ILS list id Marketing events - webinars and similar - and their attendance state. Calls DELETE /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

DESTRUCTIVE. Delete Marketing Event by objectId. Deletes the existing Marketing Event with the specified objectId, if it exists. Marketing events - webinars and similar - and their attendance state. Calls DELETE /marketing/v3/marketing-events/{objectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

DESTRUCTIVE. Delete Marketing Event by External Ids. Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app can be deleted. Marketing events - webinars and similar - and their attendance state. Calls DELETE /marketing/v3/marketing-events/events/{externalEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Retrieve audit logs. 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-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log). The portal's audit trail. ADMIN-level data: every action every user took. Read-only. Calls GET /account-info/v3/activity/audit-logs on api.hubapi.com. Requires the HubSpot scope account-info.security.read.

Retrieve login activity. Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history). The portal's audit trail. ADMIN-level data: every action every user took. Read-only. Calls GET /account-info/v3/activity/login on api.hubapi.com. Requires the HubSpot scope account-info.security.read.

Retrieve security history. Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history). The portal's audit trail. ADMIN-level data: every action every user took. Read-only. Calls GET /account-info/v3/activity/security on api.hubapi.com. Requires the HubSpot scope account-info.security.read.

Retrieve private app daily API usage. Retrieve the daily API usage for private apps in the account, along with information about usage limits. Portal identity, currencies and enabled features. The cheapest diagnostic read in the connector: it answers 'which HubSpot account is this connection actually pointed at'. Calls GET /account-info/v3/api-usage/daily/private-apps on api.hubapi.com. Requires the HubSpot scope oauth.

Retrieve account details. Retrieve account details such as the account type, time zone, currencies, and data hosting location. Portal identity, currencies and enabled features. The cheapest diagnostic read in the connector: it answers 'which HubSpot account is this connection actually pointed at'. Calls GET /account-info/v3/details on api.hubapi.com. Requires the HubSpot scope oauth.

Retrieve brands by associated user. Retrieve the brands that a specific user can access. Business units - the multi-brand division of a portal. Calls GET /business-units/v3/business-units/user/{userId} on api.hubapi.com. Requires the HubSpot scope business_units_view.read.

Retrieve all subscription status definitions. Get a list of subscription status definitions from the account. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls GET /communication-preferences/v4/definitions on api.hubapi.com. Requires the HubSpot scope communication_preferences.read.

Get subscription preferences for a specific contact. Retrieve a contact's current email subscription preferences. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls GET /communication-preferences/v4/statuses/{subscriberIdString} on api.hubapi.com. Requires the HubSpot scope communication_preferences.read.

Retrieve a contact's unsubscribed status. 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. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls GET /communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all on api.hubapi.com. Requires the HubSpot scope communication_preferences.read.

Get a single actor. Retrieve details of a single actor using the actor ID. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/actors/{actorId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get channel accounts. Retrieve a list of channel accounts, with optional filters and sorting. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/channel-accounts on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get a single channel account. Retrieve details of a single channel account using the channel account ID. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/channel-accounts/{channelAccountId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get channels. Retrieve a list of channels, with optional filters and sorting. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/channels on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get a single channel. Retrieve details of a single channel using the channel ID. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/channels/{channelId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get conversations inboxes. Retrieve a list of conversations inboxes, with optional filters and sorting. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/inboxes on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get a single conversations inbox. Retrieve details of a single conversations inbox using the inbox ID. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/inboxes/{inboxId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get threads. Retrieve a list of threads, with optional filters and sorting. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/threads on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get a single thread. Retrieve a single thread by its ID The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/threads/{threadId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get message history for a thread. Retrieve the message history for a specific thread. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/threads/{threadId}/messages on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get a single message. Retrieve a single message from a thread using the message ID. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/threads/{threadId}/messages/{messageId} on api.hubapi.com. Requires the HubSpot scope conversations.read.

Get the original content of a single message. 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`. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls GET /conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content on api.hubapi.com. Requires the HubSpot scope conversations.read.

Retrieve association labels. Retrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls GET /crm/associations/v4/{fromObjectType}/{toObjectType}/labels on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Retrieve all association limits. Retrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls GET /crm/associations/v4/definitions/configurations/all on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Retrieve association limits. Retrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls GET /crm/associations/v4/definitions/configurations/{fromObjectType}/{toObjectType} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Call transcription records and their text. Calls GET /crm/extensions/calling/v3/connection-statuses on api.hubapi.com. Requires the HubSpot scope crm.objects.owners.read.

Call transcription records and their text. Calls GET /crm/extensions/calling/v3/connection-statuses/me on api.hubapi.com. Requires the HubSpot scope crm.objects.owners.read.

Retrieve all custom object schemas. Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls GET /crm-object-schemas/v3/schemas on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.read.

Retrieve the schema of a specified custom object. Retrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls GET /crm-object-schemas/v3/schemas/{objectType} on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.read.

Retrieve a list of subscription objects. Retrieve a list of subscription objects, with options to filter by properties, associations, and archived status. Recurring Commerce Hub subscriptions. Calls GET /crm/objects/2026-03/subscriptions on api.hubapi.com. Requires the HubSpot scope crm.objects.subscriptions.read.

Retrieve a subscription. Retrieve a specific subscription by its ID, including its properties and associations. Recurring Commerce Hub subscriptions. Calls GET /crm/objects/2026-03/subscriptions/{subscriptionId} on api.hubapi.com. Requires the HubSpot scope crm.objects.subscriptions.read.

List. Read a page of projects. Control what is returned via the `properties` query param. Projects are the Service Hub project object. Calls GET /crm/objects/v3/projects on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.read.

Read. Read an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Projects are the Service Hub project object. Calls GET /crm/objects/v3/projects/{projectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.read.

Get the status of the export including the URL to download the file. Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE Bulk export jobs for CRM data. Calls GET /crm/v3/exports/export/async/tasks/{taskId}/status on api.hubapi.com. Requires the HubSpot scope crm.export.

Retrieve details of a specific export by its unique ID. Retrieve detailed information about a specific CRM export, including its current state and properties. Bulk export jobs for CRM data. Calls GET /crm/v3/exports/export/{exportId} on api.hubapi.com. Requires the HubSpot scope crm.export.

Call transcription records and their text. Calls GET /crm/v3/extensions/calling/transcripts/{transcriptId} on api.hubapi.com. Requires the HubSpot scope crm.extensions_calling_transcripts.read.

Bulk import jobs: start one, watch it, read its errors. The error read is the diagnostic that turns a failed import from a status into a cause. Calls GET /crm/v3/imports on api.hubapi.com. Requires the HubSpot scope crm.import.

Get the information on any import. A complete summary of an import record, including any updates. Bulk import jobs: start one, watch it, read its errors. The error read is the diagnostic that turns a failed import from a status into a cause. Calls GET /crm/v3/imports/{importId} on api.hubapi.com. Requires the HubSpot scope crm.import.

Retrieve errors for a specific import. Retrieves detailed error records for a specific import operation, enabling you to identify and troubleshoot records that failed during processing. Bulk import jobs: start one, watch it, read its errors. The error read is the diagnostic that turns a failed import from a status into a cause. Calls GET /crm/v3/imports/{importId}/errors on api.hubapi.com. Requires the HubSpot scope crm.import.

Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Fetch List by ID. Fetch a single list by **ILS list ID**. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/{listId} on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Fetch List Memberships Ordered by ID. Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/{listId}/memberships on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Fetch List Memberships Ordered by Added to List Date. Fetch the memberships of a list in order sorted by the time the records were added to the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/{listId}/memberships/join-order on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Retrieve the conversion details for a list. Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/{listId}/schedule-conversion on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/{listId}/size-and-edits-history/between on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Retrieves a folder. Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/folders on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Translate Legacy List Id to Modern List Id. This API allows translation of legacy list id to list id. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/idmapping on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Retrieve List by Name. Retrieve a specific list by its name and object type ID. This endpoint allows you to fetch details about a list, including its properties and optionally its filters. It is useful for accessing list information based on specific criteria. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/object-type-id/{objectTypeId}/name/{listName} on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Get lists record is member of. For given record provide lists this record is member of. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls GET /crm/v3/lists/records/{objectTypeId}/{recordId}/memberships on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Which object types are enabled in this portal - the read that tells an agent what exists before it asks for it. Calls GET /crm/v3/object-library/enablement on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Which object types are enabled in this portal - the read that tells an agent what exists before it asks for it. Calls GET /crm/v3/object-library/enablement/{objectTypeId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

List. Read a page of services. Control what is returned via the `properties` query param. Services are the service object type. Calls GET /crm/v3/objects/0-162 on api.hubapi.com. Requires the HubSpot scope crm.objects.services.read.

Read. Read an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Services are the service object type. Calls GET /crm/v3/objects/0-162/{serviceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.services.read.

List. Read a page of deals. Control what is returned via the `properties` query param. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls GET /crm/v3/objects/0-3 on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.read.

Read. Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls GET /crm/v3/objects/0-3/{dealId} on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.read.

List. Read a page of courses. Control what is returned via the `properties` query param. Courses are the education object type. Calls GET /crm/v3/objects/0-410 on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.read.

Read. Read an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Courses are the education object type. Calls GET /crm/v3/objects/0-410/{courseId} on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.read.

List. Read a page of listings. Control what is returned via the `properties` query param. Listings are the real-estate object type. Calls GET /crm/v3/objects/0-420 on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.read.

Read. Read an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Listings are the real-estate object type. Calls GET /crm/v3/objects/0-420/{listingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.read.

List. Read a page of objects. Control what is returned via the `properties` query param. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls GET /crm/v3/objects/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Read. Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls GET /crm/v3/objects/{objectType}/{objectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

List. Read a page of calls. Control what is returned via the `properties` query param. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls GET /crm/v3/objects/calls on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls GET /crm/v3/objects/calls/{callId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Retrieve carts. Retrieve all carts. You can control what is returned via the `properties` query parameter. Carts are the Commerce Hub basket object. Calls GET /crm/v3/objects/carts on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.read.

Retrieve a cart. Read an Object identified by `{cartId}`. `{cartId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Carts are the Commerce Hub basket object. Calls GET /crm/v3/objects/carts/{cartId} on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.read.

List. Read a page of commerce payments. Control what is returned via the `properties` query param. Payments recorded against invoices, subscriptions and payment links. Calls GET /crm/v3/objects/commerce_payments on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.read.

Read. Read an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Payments recorded against invoices, subscriptions and payment links. Calls GET /crm/v3/objects/commerce_payments/{commercePaymentId} on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.read.

List. Read a page of communications. Control what is returned via the `properties` query param. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls GET /crm/v3/objects/communications on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls GET /crm/v3/objects/communications/{communicationId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Retrieve companies. Retrieve all companies, using query parameters to control the information that gets returned. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls GET /crm/v3/objects/companies on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.read.

Retrieve a company. Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls GET /crm/v3/objects/companies/{companyId} on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.read.

Retrieve contacts. Retrieve all contacts, using query parameters to specify the information that gets returned. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls GET /crm/v3/objects/contacts on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Retrieve a contact. Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls GET /crm/v3/objects/contacts/{contactId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of discounts. Control what is returned via the `properties` query param. Discounts applied to quotes, invoices and orders. Calls GET /crm/v3/objects/discounts on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Read. Read an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Discounts applied to quotes, invoices and orders. Calls GET /crm/v3/objects/discounts/{discountId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

List. Read a page of emails. Control what is returned via the `properties` query param. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls GET /crm/v3/objects/emails on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls GET /crm/v3/objects/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of feedback submissions. Control what is returned via the `properties` query param. Feedback submissions are NPS, CSAT and CES survey responses. Calls GET /crm/v3/objects/feedback_submissions on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Feedback submissions are NPS, CSAT and CES survey responses. Calls GET /crm/v3/objects/feedback_submissions/{feedbackSubmissionId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of fees. Control what is returned via the `properties` query param. Fees applied to quotes, invoices and orders. Calls GET /crm/v3/objects/fees on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Read. Read an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Fees applied to quotes, invoices and orders. Calls GET /crm/v3/objects/fees/{feeId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Retrieve goal targets. Read a page of goal targets. Control what is returned via the `properties` query param. Goal targets are the per-owner sales targets Sales Hub reports against. Calls GET /crm/v3/objects/goal_targets on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.read.

Retrieve a goal target. Read an Object identified by `{goalTargetId}`. `{goalTargetId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Goal targets are the per-owner sales targets Sales Hub reports against. Calls GET /crm/v3/objects/goal_targets/{goalTargetId} on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.read.

List. Read a page of invoices. Control what is returned via the `properties` query param. Invoices are the Commerce Hub billing document. Calls GET /crm/v3/objects/invoices on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.read.

Read. Read an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Invoices are the Commerce Hub billing document. Calls GET /crm/v3/objects/invoices/{invoiceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.read.

List. Read a page of leads. Control what is returned via the `properties` query param. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls GET /crm/v3/objects/leads on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.read.

Read. Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls GET /crm/v3/objects/leads/{leadsId} on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.read.

List. Read a page of line items. Control what is returned via the `properties` query param. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls GET /crm/v3/objects/line_items on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Read. Read an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls GET /crm/v3/objects/line_items/{lineItemId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

List. Read a page of meetings. Control what is returned via the `properties` query param. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls GET /crm/v3/objects/meetings on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls GET /crm/v3/objects/meetings/{meetingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of notes. Control what is returned via the `properties` query param. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls GET /crm/v3/objects/notes on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls GET /crm/v3/objects/notes/{noteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of orders. Control what is returned via the `properties` query param. Orders are the Commerce Hub order object. Calls GET /crm/v3/objects/orders on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.read.

Read. Read an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Orders are the Commerce Hub order object. Calls GET /crm/v3/objects/orders/{orderId} on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.read.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls GET /crm/v3/objects/postal_mail on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls GET /crm/v3/objects/postal_mail/{postalMailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of products. Control what is returned via the `properties` query param. Products are the product library entries line items are created from. Calls GET /crm/v3/objects/products on api.hubapi.com. Requires the HubSpot scope crm.objects.products.read.

Read. Read an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Products are the product library entries line items are created from. Calls GET /crm/v3/objects/products/{productId} on api.hubapi.com. Requires the HubSpot scope crm.objects.products.read.

List. Read a page of quotes. Control what is returned via the `properties` query param. Quotes are the customer-facing priced document generated from a deal and its line items. Calls GET /crm/v3/objects/quotes on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.read.

Read. Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Quotes are the customer-facing priced document generated from a deal and its line items. Calls GET /crm/v3/objects/quotes/{quoteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.read.

List. Read a page of tasks. Control what is returned via the `properties` query param. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls GET /crm/v3/objects/tasks on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read. Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls GET /crm/v3/objects/tasks/{taskId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

List. Read a page of taxes. Control what is returned via the `properties` query param. Taxes applied to quotes, invoices and orders. Calls GET /crm/v3/objects/taxes on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Read. Read an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Taxes applied to quotes, invoices and orders. Calls GET /crm/v3/objects/taxes/{taxId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

List. Read a page of tickets. Control what is returned via the `properties` query param. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls GET /crm/v3/objects/tickets on api.hubapi.com. Requires the HubSpot scope tickets.

Read. Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls GET /crm/v3/objects/tickets/{ticketId} on api.hubapi.com. Requires the HubSpot scope tickets.

List. Read a page of users. Control what is returned via the `properties` query param. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls GET /crm/v3/objects/users on api.hubapi.com. Requires the HubSpot scope crm.objects.users.read.

Read. Read an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls GET /crm/v3/objects/users/{userId} on api.hubapi.com. Requires the HubSpot scope crm.objects.users.read.

Owners are the HubSpot users records can be assigned to. An owner id is required by every `hubspot_owner_id` property, and this is the only read that produces one. Calls GET /crm/v3/owners on api.hubapi.com. Requires the HubSpot scope crm.objects.owners.read.

Retrieve a specific owner by ID. Retrieve details of a specific owner using either their 'id' or 'userId'. Owners are the HubSpot users records can be assigned to. An owner id is required by every `hubspot_owner_id` property, and this is the only read that produces one. Calls GET /crm/v3/owners/{ownerId} on api.hubapi.com. Requires the HubSpot scope crm.objects.owners.read.

Retrieve all pipelines. Return all pipelines for the object type specified by `{objectType}`. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Return a pipeline by ID. Return a single pipeline object identified by its unique `{pipelineId}`. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType}/{pipelineId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Return an audit of all changes to the pipeline. Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType}/{pipelineId}/audit on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Return all stages of a pipeline. Return all the stages associated with the pipeline identified by `{pipelineId}`. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Return a pipeline stage by ID. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Read all properties. Read all existing properties for the specified object type and HubSpot account. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls GET /crm/v3/properties/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Read a property. Read a property identified by {propertyName}. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls GET /crm/v3/properties/{objectType}/{propertyName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Read all property groups. Read all existing property groups for the specified object type and HubSpot account. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls GET /crm/v3/properties/{objectType}/groups on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Read a property group. Read a property group identified by {groupName}. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls GET /crm/v3/properties/{objectType}/groups/{groupName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Read all property validation rules for an object. Read all properties with validation rules for a given object. Per-property validation rules - what HubSpot will reject before a write is attempted. Calls GET /crm/v3/property-validations/{objectTypeId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Read validation rules for a property. Read a property's validation rules identified by {propertyName}. Per-property validation rules - what HubSpot will reject before a write is attempted. Calls GET /crm/v3/property-validations/{objectTypeId}/{propertyName} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted. Retrieve a specific validation rule for a property identified by its name and rule type. Per-property validation rules - what HubSpot will reject before a write is attempted. Calls GET /crm/v3/property-validations/{objectTypeId}/{propertyName}/rule-type/{ruleType} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Retrieve all associations by object type. Retrieve all associations between a specific record and an object type. Limit 500 per call. Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls GET /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Behavioural events recorded against a contact. Calls GET /events/v3/events on api.hubapi.com. Requires the HubSpot scope oauth.

Behavioural events recorded against a contact. Calls GET /events/v3/events/event-types on api.hubapi.com. Requires the HubSpot scope oauth.

Retrieve file by ID. Retrieve a file by its ID. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/files/{fileId} on api.hubapi.com. Requires the HubSpot scope files.

The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/files/{fileId}/download on api.hubapi.com. Requires the HubSpot scope files.

Check import status. Check the status of requested import. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/files/import-from-url/async/tasks/{taskId}/status on api.hubapi.com. Requires the HubSpot scope files.

Search files. Search through files in the file manager. Does not display hidden or archived files. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls GET /files/v3/files/search on api.hubapi.com. Requires the HubSpot scope files.

Retrieve file by path. Retrieve a file by its path. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/files/stat/{path} on api.hubapi.com. Requires the HubSpot scope files.

Retrieve folder by ID. Retrieve a folder by its ID. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/folders/{folderId} on api.hubapi.com. Requires the HubSpot scope files.

Retrieve folder by path. Retrieve a folder, identified by its path. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/folders/{folderPath} on api.hubapi.com. Requires the HubSpot scope files.

Search folders. Search for folders. Does not contain hidden or archived folders. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls GET /files/v3/folders/search on api.hubapi.com. Requires the HubSpot scope files.

Check folder update status. Check status of folder update. Folder updates happen asynchronously. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls GET /files/v3/folders/update/async/tasks/{taskId}/status on api.hubapi.com. Requires the HubSpot scope files.

Get an event instance. Retrieve an event instance, specified by template ID and event ID. Timeline events are the app-authored entries on a record's activity feed. Calls GET /integrators/timeline/v3/events/{eventTemplateId}/{eventId} on api.hubapi.com. Requires the HubSpot scope timeline.

Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/marketing-events/v3 on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Read a campaign. 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 available only if startDate and endDate are provided. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

List assets. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/assets/{assetType} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Get budget item. Get a specific budget item by ID Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/budget/{budgetId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Read budget. 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 is the oldest, and items with higher order values are newer Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/budget/totals on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Fetch contact IDs. Fetch the list of contact IDs for the specified campaign and contact type Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Get Campaign Metrics. This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/reports/metrics on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Fetch revenue. Fetch revenue attribution report data for a specified campaign Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/reports/revenue on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.revenue.full.read.

Read campaign spend item. Read a campaign spend item by its spendId Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls GET /marketing/v3/campaigns/{campaignGuid}/spend/{spendId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get the details of a specified marketing email. Get the details for a marketing email. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get the variation of a an A/B marketing email. This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/{emailId}/ab-test/get-variation on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get draft version of a marketing email. Get the draft version of an email (if it exists). If no draft version exists, the published email is returned. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/{emailId}/draft on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get revisions of a marketing email. 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. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/{emailId}/revisions on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get a revision of a marketing email. Get a specific revision of a marketing email. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/{emailId}/revisions/{revisionId} on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get aggregated statistic intervals. Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/statistics/histogram on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Get aggregated statistics. 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 email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls GET /marketing/v3/emails/statistics/list on api.hubapi.com. Requires the HubSpot scope marketing.email.read.

Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls GET /marketing/v3/forms on api.hubapi.com. Requires the HubSpot scope forms.

Get a form definition. Returns a form based on the form ID provided. Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls GET /marketing/v3/forms/{formId} on api.hubapi.com. Requires the HubSpot scope forms.

Get lists associated with a marketing event. Gets lists associated with a marketing event by external account id and external event id Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Get lists associated with a marketing event. Gets lists associated with a marketing event by marketing event id Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/associations/{marketingEventId}/lists on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Find Marketing Events by External Event Id. This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/{externalEventId}/identifiers on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Get Marketing Event by objectId. Returns the details of a Marketing Event with the specified objectId, if it exists. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/{objectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Get Marketing Event by External IDs. Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app making the request can be retrieved. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/events/{externalEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Find App-Specific Marketing Events by External Event Id. Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. Marketing Events created by other apps will not be included in the results. Marketing events - webinars and similar - and their attendance state. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls GET /marketing/v3/marketing-events/events/search on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Read participations counters by Marketing Event external identifier. Read Marketing event's participations counters by externalAccountId and externalEventId pair. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Read participations breakdown by Marketing Event external identifier. Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Read participations counters by Marketing Event internal identifier. Read Marketing event's participations counters by internal identifier marketingEventId. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/participations/{marketingEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Read participations breakdown by Marketing Event internal identifier. Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/participations/{marketingEventId}/breakdown on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Read participations breakdown by Contact identifier. Read Contact's participations by identifier - email or internal id. Marketing events - webinars and similar - and their attendance state. Calls GET /marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.read.

Get meeting scheduling pages. Get a paged list meeting scheduling pages Meeting engagements on a record's timeline. Gated on the contacts scope. Calls GET /scheduler/v3/meetings/meeting-links on api.hubapi.com. Requires the HubSpot scope scheduler.meetings.meeting-link.read.

Get the availability for a meeting. Get the next availability times for a meeting page. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls GET /scheduler/v3/meetings/meeting-links/book/availability-page/{slug} on api.hubapi.com. Requires the HubSpot scope scheduler.meetings.meeting-link.read.

List booking information. Get details about the initial information necessary for a meeting scheduler. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls GET /scheduler/v3/meetings/meeting-links/book/{slug} on api.hubapi.com. Requires the HubSpot scope scheduler.meetings.meeting-link.read.

Update a thread. Updates a single thread. Either a thread's status can be updated, or the thread can be restored. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls PATCH /conversations/v3/conversations/threads/{threadId} on api.hubapi.com. Requires the HubSpot scope conversations.write.

Update the schema of a specified custom object. Update attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls PATCH /crm-object-schemas/v3/schemas/{objectType} on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.write.

Update a subscription. Update a specific subscription by its ID with new property values. Recurring Commerce Hub subscriptions. Calls PATCH /crm/objects/2026-03/subscriptions/{subscriptionId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Projects are the Service Hub project object. Calls PATCH /crm/objects/v3/projects/{projectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

Update. Perform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Services are the service object type. Calls PATCH /crm/v3/objects/0-162/{serviceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

Update. Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls PATCH /crm/v3/objects/0-3/{dealId} on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

Update. Perform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Courses are the education object type. Calls PATCH /crm/v3/objects/0-410/{courseId} on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

Update. Perform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Listings are the real-estate object type. Calls PATCH /crm/v3/objects/0-420/{listingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

Update. Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls PATCH /crm/v3/objects/{objectType}/{objectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Update. Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls PATCH /crm/v3/objects/calls/{callId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update a cart. Perform a partial update of an Object identified by `{cartId}`or optionally a unique property value as specified by the `idProperty` query param. `{cartId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Carts are the Commerce Hub basket object. Calls PATCH /crm/v3/objects/carts/{cartId} on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

Update. Perform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Payments recorded against invoices, subscriptions and payment links. Calls PATCH /crm/v3/objects/commerce_payments/{commercePaymentId} on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

Update. Perform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls PATCH /crm/v3/objects/communications/{communicationId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update a company. Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls PATCH /crm/v3/objects/companies/{companyId} on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

Update a contact. Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by pass... Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls PATCH /crm/v3/objects/contacts/{contactId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Discounts applied to quotes, invoices and orders. Calls PATCH /crm/v3/objects/discounts/{discountId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Update. Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls PATCH /crm/v3/objects/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Fees applied to quotes, invoices and orders. Calls PATCH /crm/v3/objects/fees/{feeId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Update a goal target. Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Goal targets are the per-owner sales targets Sales Hub reports against. Calls PATCH /crm/v3/objects/goal_targets/{goalTargetId} on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

Update. Perform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Invoices are the Commerce Hub billing document. Calls PATCH /crm/v3/objects/invoices/{invoiceId} on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

Update. Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls PATCH /crm/v3/objects/leads/{leadsId} on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

Update. Perform a partial update of an Object identified by `{lineItemId}`or optionally a unique property value as specified by the `idProperty` query param. `{lineItemId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls PATCH /crm/v3/objects/line_items/{lineItemId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Update. Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls PATCH /crm/v3/objects/meetings/{meetingId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls PATCH /crm/v3/objects/notes/{noteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Orders are the Commerce Hub order object. Calls PATCH /crm/v3/objects/orders/{orderId} on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls PATCH /crm/v3/objects/postal_mail/{postalMailId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Products are the product library entries line items are created from. Calls PATCH /crm/v3/objects/products/{productId} on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

Update. Perform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Quotes are the customer-facing priced document generated from a deal and its line items. Calls PATCH /crm/v3/objects/quotes/{quoteId} on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

Update. Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls PATCH /crm/v3/objects/tasks/{taskId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Update. Perform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Taxes applied to quotes, invoices and orders. Calls PATCH /crm/v3/objects/taxes/{taxId} on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Update. Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls PATCH /crm/v3/objects/tickets/{ticketId} on api.hubapi.com. Requires the HubSpot scope tickets.

Update. Perform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls PATCH /crm/v3/objects/users/{userId} on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls PATCH /crm/v3/pipelines/{objectType}/{pipelineId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls PATCH /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Update a property. Perform a partial update of a property identified by '{propertyName}'. Provided fields will be overwritten. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls PATCH /crm/v3/properties/{objectType}/{propertyName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Update a property group. Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls PATCH /crm/v3/properties/{objectType}/groups/{groupName} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Update file properties. Update properties of file by ID. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls PATCH /files/v3/files/{fileId} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Update folder properties by folder ID. Update a folder's properties, identified by folder ID. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls PATCH /files/v3/folders/{folderId} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Update campaign. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls PATCH /marketing/v3/campaigns/{campaignGuid} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Update a marketing email. Change properties of a marketing email. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls PATCH /marketing/v3/emails/{emailId} on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Create or update draft version. 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. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls PATCH /marketing/v3/emails/{emailId}/draft on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Partially update a form definition. Update some of the form definition components Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls PATCH /marketing/v3/forms/{formId} on api.hubapi.com. Requires the HubSpot scope forms.

Update Marketing Event by objectId. Updates the details of an existing Marketing Event identified by its objectId, if it exists. Marketing events - webinars and similar - and their attendance state. Calls PATCH /marketing/v3/marketing-events/{objectId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Update Marketing Event by External IDs. Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. Only Marketing Events created by the same app can be updated. Marketing events - webinars and similar - and their attendance state. Calls PATCH /marketing/v3/marketing-events/events/{externalEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Meeting engagements on a record's timeline. Gated on the contacts scope. Calls PATCH /scheduler/v3/meetings/meeting-links/{meetingLinkSlug} on api.hubapi.com. Requires the HubSpot scope meetings-write.

Generate subscription links. 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 potential issues](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/generate-url-guide). Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/links/generate on api.hubapi.com. Requires the HubSpot scope communication_preferences.read_write.

Batch read statuses. 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. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/batch/read on api.hubapi.com. Requires the HubSpot scope communication_preferences.statuses.batch.read.

Batch unsubscribe contacts from all subscriptions. Unsubscribe a set of contacts from all email subscriptions. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/batch/unsubscribe-all on api.hubapi.com. Requires the HubSpot scope communication_preferences.statuses.batch.write.

Batch read statuses. 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. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/batch/unsubscribe-all/read on api.hubapi.com. Requires the HubSpot scope communication_preferences.statuses.batch.read.

Batch update subscription status. Update the subscription status for a set of contacts. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/batch/write on api.hubapi.com. Requires the HubSpot scope communication_preferences.statuses.batch.write.

Update a contact's subscription status. Set the subscription status of a specific contact. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/{subscriberIdString} on api.hubapi.com. Requires the HubSpot scope communication_preferences.read_write.

Unsubscribe a contact from all subscriptions. Unsubscribe a contact from all email subscriptions. Communication preferences - a contact's subscription status per subscription type, and the legal basis recorded for it. This is the GDPR-relevant surface: read it before any send decision. Calls POST /communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all on api.hubapi.com. Requires the HubSpot scope communication_preferences.read_write.

Get a group of actors. Resolve a set of `ActorId`s to the underlying actors/participants. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls POST /conversations/v3/conversations/actors/batch/read on api.hubapi.com. Requires the HubSpot scope conversations.read.

Send a message to a thread. Send a new message on a thread at the current timestamp. The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls POST /conversations/v3/conversations/threads/{threadId}/messages on api.hubapi.com. Requires the HubSpot scope conversations.write.

Create association label. Create a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls POST /crm/associations/v4/{fromObjectType}/{toObjectType}/labels on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Configure association limits. Batch configure association limits between two object types. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls POST /crm/associations/v4/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Remove association limits. Batch delete limits that have been defined for association types between two object types. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Requires confirm="purge-association-definitions" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/associations/v4/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Update association limits. Batch update association limits that have been configured between two object types. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls POST /crm/associations/v4/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Call transcription records and their text. Calls POST /crm/extensions/calling/v3/connection-statuses/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.owners.read.

Create a new custom object schema. Create a new custom object schema by defining its properties and associations. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls POST /crm-object-schemas/v3/schemas on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.write.

Retrieve multiple custom object schemas in a batch request. Retrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls POST /crm-object-schemas/v3/schemas/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.custom.read.

Create an association for a specified object type. Create a new association between the specified object type and another object type. This operation requires the definition of the association attributes, such as the primary and target object type IDs. Custom OBJECT TYPE definitions - the schema of a customer-defined object, not its records. This is what names the objectTypeId the generic object operations take. Calls POST /crm-object-schemas/v3/schemas/{objectType}/associations on api.hubapi.com. Requires the HubSpot scope crm.schemas.custom.write.

Create a new subscription object. Create a new subscription object with specified properties and optional associations. Recurring Commerce Hub subscriptions. Calls POST /crm/objects/2026-03/subscriptions on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive multiple subscription objects in a single request. Archive a batch of subscription objects by providing their IDs in the request body. Recurring Commerce Hub subscriptions. The inverse is the batch create on the same object family. Calls POST /crm/objects/2026-03/subscriptions/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Batch create subscription objects. Create multiple subscription objects in a single batch operation, allowing for efficient data entry and management. Recurring Commerce Hub subscriptions. Calls POST /crm/objects/2026-03/subscriptions/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Retrieve a batch of subscription objects by IDs. Retrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories. Recurring Commerce Hub subscriptions. Calls POST /crm/objects/2026-03/subscriptions/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.subscriptions.read.

Update multiple subscriptions in a batch. Update multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records. Recurring Commerce Hub subscriptions. Calls POST /crm/objects/2026-03/subscriptions/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Perform a batch upsert operation on subscription objects. This endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects. Recurring Commerce Hub subscriptions. Calls POST /crm/objects/2026-03/subscriptions/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for CRM commerce subscriptions using specified criteria. Execute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters. Recurring Commerce Hub subscriptions. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/objects/2026-03/subscriptions/search on api.hubapi.com. Requires the HubSpot scope crm.objects.subscriptions.read.

Read a batch of deal split objects by their associated deal object internal ID. Deal splits divide a deal's credit between owners. Calls POST /crm/objects/v3/deals/splits/batch/read on api.hubapi.com. Requires the HubSpot scope crm.dealsplits.read_write.

Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places. Deal splits divide a deal's credit between owners. Calls POST /crm/objects/v3/deals/splits/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.dealsplits.read_write.

Create. Create a project with the given properties and return a copy of the object, including the ID. Projects are the Service Hub project object. Calls POST /crm/objects/v3/projects on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

DESTRUCTIVE. Archive a batch of projects. Archive multiple projects using their IDs. Projects are the Service Hub project object. The inverse is the batch create on the same object family. Calls POST /crm/objects/v3/projects/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

Create a batch of projects. Create multiple projects in a single request. Projects are the Service Hub project object. Calls POST /crm/objects/v3/projects/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

Read a batch of projects. Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property. Projects are the Service Hub project object. Calls POST /crm/objects/v3/projects/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.read.

Update a batch of projects. Update multiple projects using their internal IDs or unique property values. Projects are the Service Hub project object. Calls POST /crm/objects/v3/projects/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

Create or update a batch of projects. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Projects are the Service Hub project object. Calls POST /crm/objects/v3/projects/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

DESTRUCTIVE. Merge two projects. Merge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). Projects are the Service Hub project object. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/objects/v3/projects/merge on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.write.

Search for projects. Search for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Projects are the Service Hub project object. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/objects/v3/projects/search on api.hubapi.com. Requires the HubSpot scope crm.objects.projects.read.

Start an export. Begins exporting CRM data for the portal as specified in the request body Bulk export jobs for CRM data. Calls POST /crm/v3/exports/export/async on api.hubapi.com. Requires the HubSpot scope crm.export.

Call transcription records and their text. Calls POST /crm/v3/extensions/calling/inbound-call on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Call transcription records and their text. Calls POST /crm/v3/extensions/calling/transcripts on api.hubapi.com. Requires the HubSpot scope crm.extensions_calling_transcripts.write.

Bulk import jobs: start one, watch it, read its errors. The error read is the diagnostic that turns a failed import from a status into a cause. Calls POST /crm/v3/imports on api.hubapi.com. Requires the HubSpot scope crm.import.

Cancel an active import. This allows a developer to cancel an active import. Bulk import jobs: start one, watch it, read its errors. The error read is the diagnostic that turns a failed import from a status into a cause. Calls POST /crm/v3/imports/{importId}/cancel on api.hubapi.com. Requires the HubSpot scope crm.import.

Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls POST /crm/v3/lists on api.hubapi.com. Requires the HubSpot scope crm.lists.write.

Creates a folder. Creates a folder with the given information. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls POST /crm/v3/lists/folders on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Translate Legacy List Id to Modern List Id in Batch. This API allows translation of a batch of legacy list id's to list id's. This allows for a maximum of 10,000 id's. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls POST /crm/v3/lists/idmapping on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls POST /crm/v3/lists/records/memberships/batch/read on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Search Lists. Search lists by list name or page through all lists by providing an empty `query` value. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/lists/search on api.hubapi.com. Requires the HubSpot scope crm.lists.read.

Create. Create a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided. Services are the service object type. Calls POST /crm/v3/objects/0-162 on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

DESTRUCTIVE. Archive a batch of services by ID. Archive a batch of objects Services are the service object type. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/0-162/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

Create a batch of services. Create a batch of objects Services are the service object type. Calls POST /crm/v3/objects/0-162/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

Read a batch of services by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Services are the service object type. Calls POST /crm/v3/objects/0-162/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.services.read.

Update a batch of services by internal ID, or unique property values. Update a batch of objects Services are the service object type. Calls POST /crm/v3/objects/0-162/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

Create or update a batch of services by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Services are the service object type. Calls POST /crm/v3/objects/0-162/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.services.write.

Search across objects. Fetch objects via a search query Services are the service object type. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/0-162/search on api.hubapi.com. Requires the HubSpot scope crm.objects.services.read.

Create. Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls POST /crm/v3/objects/0-3 on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

DESTRUCTIVE. Archive a batch of deals by ID. Archive multiple deals using their IDs. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/0-3/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

Create a batch of deals. Create multiple deals in a single request. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls POST /crm/v3/objects/0-3/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

Read a batch of deals by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls POST /crm/v3/objects/0-3/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.read.

Update a batch of deals by internal ID, or unique property values. Update multiple deals using their internal IDs or unique property values. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls POST /crm/v3/objects/0-3/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

Create or update a batch of deals by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. Calls POST /crm/v3/objects/0-3/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

DESTRUCTIVE. Merge two deals with same type. Combine two deals of the same type into a single deal. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/0-3/merge on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.write.

Search for deals using various filters and criteria to retrieve specific records. Search for deals using specified criteria and filters. Deals are the revenue pipeline. HubSpot addresses the deal object by its internal object type id `0-3`, which is why these paths read /crm/v3/objects/0-3 rather than /deals; both forms are accepted by HubSpot and 0-3 is what its own v3 specification publishes. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/0-3/search on api.hubapi.com. Requires the HubSpot scope crm.objects.deals.read.

Create. Create a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided. Courses are the education object type. Calls POST /crm/v3/objects/0-410 on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

DESTRUCTIVE. Archive a batch of courses by ID. Archive a batch of objects Courses are the education object type. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/0-410/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

Create a batch of courses. Create a batch of objects Courses are the education object type. Calls POST /crm/v3/objects/0-410/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

Read a batch of courses by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Courses are the education object type. Calls POST /crm/v3/objects/0-410/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.read.

Update a batch of courses by internal ID, or unique property values. Update a batch of objects Courses are the education object type. Calls POST /crm/v3/objects/0-410/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

Create or update a batch of courses by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Courses are the education object type. Calls POST /crm/v3/objects/0-410/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.write.

Search for objects. Fetch objects using a search query Courses are the education object type. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/0-410/search on api.hubapi.com. Requires the HubSpot scope crm.objects.courses.read.

Create. Create a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided. Listings are the real-estate object type. Calls POST /crm/v3/objects/0-420 on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

DESTRUCTIVE. Archive a batch of listings by ID. Archive multiple listings by their IDs. Listings are the real-estate object type. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/0-420/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

Create a batch of listings. Create multiple listings in a single request. Listings are the real-estate object type. Calls POST /crm/v3/objects/0-420/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

Read a batch of listings by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Listings are the real-estate object type. Calls POST /crm/v3/objects/0-420/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.read.

Update a batch of listings by internal ID, or unique property values. Update multiple listings using their internal IDs or unique property values. Listings are the real-estate object type. Calls POST /crm/v3/objects/0-420/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

Create or update a batch of listings by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Listings are the real-estate object type. Calls POST /crm/v3/objects/0-420/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.write.

Search for listings using various criteria and filters. Execute a search query to find listings based on specified filters and properties. Listings are the real-estate object type. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/0-420/search on api.hubapi.com. Requires the HubSpot scope crm.objects.listings.read.

Create. Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls POST /crm/v3/objects/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Archive a batch of objects by ID. Archive a batch of objects by their unique IDs. This operation moves the specified objects to the recycling bin, effectively marking them as archived. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/{objectType}/batch/archive on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Create a batch of objects. Create multiple CRM objects in a single request by specifying the object type and providing the necessary properties and associations for each object. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls POST /crm/v3/objects/{objectType}/batch/create on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Read a batch of objects by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls POST /crm/v3/objects/{objectType}/batch/read on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Update a batch of objects by internal ID, or unique property values. Update a batch of CRM objects by their internal IDs or unique property values, allowing for efficient modifications of multiple records in a single request. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls POST /crm/v3/objects/{objectType}/batch/update on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Create or update a batch of objects by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. Calls POST /crm/v3/objects/{objectType}/batch/upsert on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Merge two objects with same type. Merge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/{objectType}/merge on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Search for CRM objects of a specified type. Execute a search query to find CRM objects of a given type, using specified filters and properties. The search can be customized with filters, sorting, and pagination options. The GENERIC CRM object API. `objectType` is an argument, so these operations reach ANY object type in the portal - the standard ones and every custom object the customer has defined. This is the only way a custom object is reachable at all. Because the object type is chosen at call time the credential has to cover every type the caller may name, which is why these carry the core object scopes rather than one. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/{objectType}/search on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Create. Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls POST /crm/v3/objects/calls on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of calls by ID. Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record). Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/calls/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of calls. Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls POST /crm/v3/objects/calls/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of calls by internal ID, or unique property values. Retrieve a batch of calls by ID. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls POST /crm/v3/objects/calls/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of calls by internal ID, or unique property values. Update a batch of calls by ID. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls POST /crm/v3/objects/calls/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of calls by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. Calls POST /crm/v3/objects/calls/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for calls. Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Call engagements: logged calls with their disposition, duration and recording metadata. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/calls/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create a cart. Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided. Carts are the Commerce Hub basket object. Calls POST /crm/v3/objects/carts on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

DESTRUCTIVE. Archive a batch of carts by ID. Archive a batch of carts identified by their IDs. Carts are the Commerce Hub basket object. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/carts/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

Create a batch of carts. Create a batch of carts with specified properties and associations. Carts are the Commerce Hub basket object. Calls POST /crm/v3/objects/carts/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

Read a batch of carts by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Carts are the Commerce Hub basket object. Calls POST /crm/v3/objects/carts/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.read.

Update a batch of carts by internal ID, or unique property values. Update a batch of carts using their internal IDs or unique property values. Carts are the Commerce Hub basket object. Calls POST /crm/v3/objects/carts/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

Create or update a batch of carts by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Carts are the Commerce Hub basket object. Calls POST /crm/v3/objects/carts/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.write.

Search for carts. Search for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results. Carts are the Commerce Hub basket object. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/carts/search on api.hubapi.com. Requires the HubSpot scope crm.objects.carts.read.

Create. Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided. Payments recorded against invoices, subscriptions and payment links. Calls POST /crm/v3/objects/commerce_payments on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

DESTRUCTIVE. Archive a batch of commerce payments by ID. Archive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system. Payments recorded against invoices, subscriptions and payment links. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/commerce_payments/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

Create a batch of commerce payments. Create multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs. Payments recorded against invoices, subscriptions and payment links. Calls POST /crm/v3/objects/commerce_payments/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

Read a batch of commerce payments by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Payments recorded against invoices, subscriptions and payment links. Calls POST /crm/v3/objects/commerce_payments/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.read.

Update a batch of commerce payments by internal ID, or unique property values. Update multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values. Payments recorded against invoices, subscriptions and payment links. Calls POST /crm/v3/objects/commerce_payments/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

Create or update a batch of commerce payments by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Payments recorded against invoices, subscriptions and payment links. Calls POST /crm/v3/objects/commerce_payments/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.write.

Search for commerce payments using specified criteria. Execute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM. Payments recorded against invoices, subscriptions and payment links. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/commerce_payments/search on api.hubapi.com. Requires the HubSpot scope crm.objects.commercepayments.read.

Create. Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls POST /crm/v3/objects/communications on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of communications by ID. Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record). Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/communications/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of communications. Create a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls POST /crm/v3/objects/communications/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of communications by internal ID, or unique property values. Retrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls POST /crm/v3/objects/communications/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of communications by internal ID, or unique property values. Update a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls POST /crm/v3/objects/communications/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of communications by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. Calls POST /crm/v3/objects/communications/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for messages. Search for messages by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Communications are the SMS, WhatsApp and LinkedIn message engagements. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/communications/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create a company. Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls POST /crm/v3/objects/companies on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

DESTRUCTIVE. Archive a batch of companies. Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records). Companies are the organisations contacts belong to. A company id is what associates a deal with an account. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/companies/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

Create a batch of companies. Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls POST /crm/v3/objects/companies/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

Retrieve a batch of companies. Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls POST /crm/v3/objects/companies/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.read.

Update a batch of companies. Update a batch of companies by ID. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls POST /crm/v3/objects/companies/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

Create or update a batch of companies by unique property values. Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object. Companies are the organisations contacts belong to. A company id is what associates a deal with an account. Calls POST /crm/v3/objects/companies/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

DESTRUCTIVE. Merge two companies. Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). Companies are the organisations contacts belong to. A company id is what associates a deal with an account. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/companies/merge on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.write.

Search for companies. Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Companies are the organisations contacts belong to. A company id is what associates a deal with an account. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/companies/search on api.hubapi.com. Requires the HubSpot scope crm.objects.companies.read.

Create a contact. Create a single contact. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the contact, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls POST /crm/v3/objects/contacts on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of contacts. Archive a batch of contacts by ID. Archived contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/contacts/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of contacts. Create a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls POST /crm/v3/objects/contacts/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Retrieve a batch of contacts. Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls POST /crm/v3/objects/contacts/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of contacts. Update a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls POST /crm/v3/objects/contacts/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of contacts. Upsert a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record. Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. Calls POST /crm/v3/objects/contacts/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Permanently delete a contact (GDPR-compliant). Permanently delete a contact and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about [permanently deleting contacts](https://knowledge.hubspot.com/privacy-and-consent/how-do-i-perform-a-gdpr-delete-in-hubspot). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. There is NO undo and no recovery: HubSpot erases the person permanently and refuses to re-create them from the same email address, which is blocklisted from then on. Requires confirm="erase-this-person-permanently" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/contacts/gdpr-delete on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Merge two contacts. Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/contacts/merge on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for contacts. Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Contacts are people. Every engagement, list membership and deal association hangs off a contact id, so the contact reads are usually the first call of a HubSpot session. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/contacts/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided. Discounts applied to quotes, invoices and orders. Calls POST /crm/v3/objects/discounts on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive a batch of discounts by ID. Archive multiple discounts by their IDs in a single request. This operation moves the specified discounts to the recycling bin, effectively removing them from active use. Discounts applied to quotes, invoices and orders. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/discounts/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create a batch of discounts. Create multiple discounts in a single request by providing the necessary properties and associations for each discount. This operation returns a list of the created discounts, including their unique identifiers. Discounts applied to quotes, invoices and orders. Calls POST /crm/v3/objects/discounts/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Read a batch of discounts by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Discounts applied to quotes, invoices and orders. Calls POST /crm/v3/objects/discounts/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Update a batch of discounts by internal ID, or unique property values. Update multiple discounts by specifying either their internal IDs or unique property values. This operation allows you to modify the properties of several discount records in a single request. Discounts applied to quotes, invoices and orders. Calls POST /crm/v3/objects/discounts/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create or update a batch of discounts by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Discounts applied to quotes, invoices and orders. Calls POST /crm/v3/objects/discounts/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Search for a discount. Search for discounts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Discounts applied to quotes, invoices and orders. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/discounts/search on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Create. Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls POST /crm/v3/objects/emails on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of emails by ID. Archive a batch of emails identified by their IDs. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/emails/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of emails. Create a batch of emails with specified properties and return the created objects. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls POST /crm/v3/objects/emails/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of emails by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls POST /crm/v3/objects/emails/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of emails by internal ID, or unique property values. Update a batch of emails using their internal IDs or unique property values. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls POST /crm/v3/objects/emails/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of emails by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. Calls POST /crm/v3/objects/emails/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for emails using specified criteria and filters. Perform a search for emails based on the provided query parameters and return matching results. Logged email engagements on a record's timeline. This is the CRM record of an email, not a send: nothing here delivers mail. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/emails/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Read a batch of feedback submissions by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Feedback submissions are NPS, CSAT and CES survey responses. Calls POST /crm/v3/objects/feedback_submissions/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Search for feedback submissions using specified criteria. Execute a search to retrieve feedback submissions based on defined filters, properties, and sorting options. Feedback submissions are NPS, CSAT and CES survey responses. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/feedback_submissions/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided. Fees applied to quotes, invoices and orders. Calls POST /crm/v3/objects/fees on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive a batch of fees by ID. Archive multiple fees by their IDs, effectively moving them to the recycling bin. Fees applied to quotes, invoices and orders. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/fees/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create a batch of fees. Create multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers. Fees applied to quotes, invoices and orders. Calls POST /crm/v3/objects/fees/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Read a batch of fees by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Fees applied to quotes, invoices and orders. Calls POST /crm/v3/objects/fees/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Update a batch of fees by internal ID, or unique property values. Update multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk. Fees applied to quotes, invoices and orders. Calls POST /crm/v3/objects/fees/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create or update a batch of fees by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Fees applied to quotes, invoices and orders. Calls POST /crm/v3/objects/fees/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Search for fees using specified criteria. Perform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results. Fees applied to quotes, invoices and orders. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/fees/search on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Create a goal target. Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided. Goal targets are the per-owner sales targets Sales Hub reports against. Calls POST /crm/v3/objects/goal_targets on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

DESTRUCTIVE. Archive a batch of goal targets by ID. Archive multiple goal targets in a single batch operation using their IDs. Goal targets are the per-owner sales targets Sales Hub reports against. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/goal_targets/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

Create a batch of goal targets. Create multiple goal targets in a single batch operation. Goal targets are the per-owner sales targets Sales Hub reports against. Calls POST /crm/v3/objects/goal_targets/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

Read a batch of goal targets by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Goal targets are the per-owner sales targets Sales Hub reports against. Calls POST /crm/v3/objects/goal_targets/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.read.

Update a batch of goal targets by internal ID, or unique property values. Update multiple goal targets in a single batch operation using their internal IDs or unique property values. Goal targets are the per-owner sales targets Sales Hub reports against. Calls POST /crm/v3/objects/goal_targets/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

Create or update a batch of goal targets by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Goal targets are the per-owner sales targets Sales Hub reports against. Calls POST /crm/v3/objects/goal_targets/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.write.

Search for goal targets. Search for goal targets using specified criteria. Goal targets are the per-owner sales targets Sales Hub reports against. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/goal_targets/search on api.hubapi.com. Requires the HubSpot scope crm.objects.goals.read.

Create. Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided. Invoices are the Commerce Hub billing document. Calls POST /crm/v3/objects/invoices on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

DESTRUCTIVE. Archive a batch of invoices by ID. Archive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference. Invoices are the Commerce Hub billing document. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/invoices/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

Create a batch of invoices. Create multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs. Invoices are the Commerce Hub billing document. Calls POST /crm/v3/objects/invoices/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

Read a batch of invoices by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Invoices are the Commerce Hub billing document. Calls POST /crm/v3/objects/invoices/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.read.

Update a batch of invoices by internal ID, or unique property values. Update multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records. Invoices are the Commerce Hub billing document. Calls POST /crm/v3/objects/invoices/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

Create or update a batch of invoices by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Invoices are the Commerce Hub billing document. Calls POST /crm/v3/objects/invoices/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.write.

Search for invoices using specified criteria. Execute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups. Invoices are the Commerce Hub billing document. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/invoices/search on api.hubapi.com. Requires the HubSpot scope crm.objects.invoices.read.

Create. Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls POST /crm/v3/objects/leads on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

DESTRUCTIVE. Archive a batch of leads by ID. Archive multiple leads by their IDs in a single request, moving them to the recycling bin. Leads are the Sales Hub prospecting object that sits in front of a contact. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/leads/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

Create a batch of leads. Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls POST /crm/v3/objects/leads/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

Read a batch of leads by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls POST /crm/v3/objects/leads/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.read.

Update a batch of leads by internal ID, or unique property values. Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls POST /crm/v3/objects/leads/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

Create or update a batch of leads by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Leads are the Sales Hub prospecting object that sits in front of a contact. Calls POST /crm/v3/objects/leads/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.write.

Search for leads using specified criteria. Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page. Leads are the Sales Hub prospecting object that sits in front of a contact. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/leads/search on api.hubapi.com. Requires the HubSpot scope crm.objects.leads.read.

Create. Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls POST /crm/v3/objects/line_items on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive a batch of line items by ID. Archive multiple line items simultaneously by specifying their IDs in the request body. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/line_items/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create a batch of line items. Create multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls POST /crm/v3/objects/line_items/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Read a batch of line items by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls POST /crm/v3/objects/line_items/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Update a batch of line items by internal ID, or unique property values. Update multiple line items using their internal IDs or unique property values. This endpoint allows for batch processing of updates, ensuring efficient modification of line item records in bulk. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls POST /crm/v3/objects/line_items/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create or update a batch of line items by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. Calls POST /crm/v3/objects/line_items/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Search for line items. Execute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations. Line items are the priced rows on a deal, quote, invoice or order. They cannot exist alone; each one is associated to its parent object. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/line_items/search on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Create. Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /crm/v3/objects/meetings on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of meetings by ID. Meeting engagements on a record's timeline. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/meetings/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of meetings. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /crm/v3/objects/meetings/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of meetings by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /crm/v3/objects/meetings/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of meetings by internal ID, or unique property values. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /crm/v3/objects/meetings/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of meetings by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /crm/v3/objects/meetings/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Meeting engagements on a record's timeline. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/meetings/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls POST /crm/v3/objects/notes on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of notes by ID. Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/notes/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of notes. Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls POST /crm/v3/objects/notes/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of notes by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls POST /crm/v3/objects/notes/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of notes by internal ID, or unique property values. Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls POST /crm/v3/objects/notes/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of notes by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. Calls POST /crm/v3/objects/notes/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for notes based on specified criteria. Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system. Notes are free-text engagements on a record's timeline. Like every engagement object they are gated on the CONTACTS scope, not a notes scope - that is HubSpot's own model, not an approximation. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/notes/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided. Orders are the Commerce Hub order object. Calls POST /crm/v3/objects/orders on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

DESTRUCTIVE. Archive a batch of orders by ID. Archive a batch of orders identified by their IDs. Orders are the Commerce Hub order object. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/orders/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

Create a batch of orders. Create a batch of orders in the system. Orders are the Commerce Hub order object. Calls POST /crm/v3/objects/orders/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

Read a batch of orders by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Orders are the Commerce Hub order object. Calls POST /crm/v3/objects/orders/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.read.

Update a batch of orders by internal ID, or unique property values. Update a batch of orders using their internal IDs or unique property values. Orders are the Commerce Hub order object. Calls POST /crm/v3/objects/orders/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

Create or update a batch of orders by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Orders are the Commerce Hub order object. Calls POST /crm/v3/objects/orders/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.write.

Search for orders in the CRM using various filters and sorting options to retrieve specific order data. Execute a search for orders using specified criteria and return matching results. Orders are the Commerce Hub order object. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/orders/search on api.hubapi.com. Requires the HubSpot scope crm.objects.orders.read.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls POST /crm/v3/objects/postal_mail on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/postal_mail/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls POST /crm/v3/objects/postal_mail/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls POST /crm/v3/objects/postal_mail/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls POST /crm/v3/objects/postal_mail/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. Calls POST /crm/v3/objects/postal_mail/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Postal mail engagements - physical mail logged against a record. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/postal_mail/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided. Products are the product library entries line items are created from. Calls POST /crm/v3/objects/products on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

DESTRUCTIVE. Archive a batch of products by ID. Archive multiple products at once by providing their IDs. This operation moves the specified products to the recycling bin, effectively removing them from active use without permanently deleting them. Products are the product library entries line items are created from. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/products/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

Create a batch of products. Create multiple products in a single request by specifying their properties, and receive a response containing the details of the created products. Products are the product library entries line items are created from. Calls POST /crm/v3/objects/products/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

Read a batch of products by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Products are the product library entries line items are created from. Calls POST /crm/v3/objects/products/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.products.read.

Update a batch of products by internal ID, or unique property values. Update multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error. Products are the product library entries line items are created from. Calls POST /crm/v3/objects/products/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

Create or update a batch of products by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Products are the product library entries line items are created from. Calls POST /crm/v3/objects/products/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.products.write.

Search for products using specified criteria. Execute a search for products based on defined filters, properties, and sorting options. This endpoint allows for detailed querying of product data within the CRM, enabling users to retrieve specific product information by applying multiple filter groups and sorting criteria. Products are the product library entries line items are created from. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/products/search on api.hubapi.com. Requires the HubSpot scope crm.objects.products.read.

Create. Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided. Quotes are the customer-facing priced document generated from a deal and its line items. Calls POST /crm/v3/objects/quotes on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

DESTRUCTIVE. Archive a batch of quotes by ID. Archive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin. Quotes are the customer-facing priced document generated from a deal and its line items. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/quotes/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

Create a batch of quotes. Create multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations. Quotes are the customer-facing priced document generated from a deal and its line items. Calls POST /crm/v3/objects/quotes/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

Read a batch of quotes by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Quotes are the customer-facing priced document generated from a deal and its line items. Calls POST /crm/v3/objects/quotes/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.read.

Update a batch of quotes by internal ID, or unique property values. Update multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request. Quotes are the customer-facing priced document generated from a deal and its line items. Calls POST /crm/v3/objects/quotes/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

Create or update a batch of quotes by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Quotes are the customer-facing priced document generated from a deal and its line items. Calls POST /crm/v3/objects/quotes/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.write.

Search for quotes using specified criteria. Execute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets. Quotes are the customer-facing priced document generated from a deal and its line items. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/quotes/search on api.hubapi.com. Requires the HubSpot scope crm.objects.quotes.read.

Create. Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls POST /crm/v3/objects/tasks on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

DESTRUCTIVE. Archive a batch of tasks by ID. Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/tasks/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create a batch of tasks. Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls POST /crm/v3/objects/tasks/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Read a batch of tasks by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls POST /crm/v3/objects/tasks/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Update a batch of tasks by internal ID, or unique property values. Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls POST /crm/v3/objects/tasks/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Create or update a batch of tasks by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. Calls POST /crm/v3/objects/tasks/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Search for tasks using specified criteria. Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values. Tasks are the to-do engagements assigned to an owner. Gated on the contacts scope. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/tasks/search on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.read.

Create. Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided. Taxes applied to quotes, invoices and orders. Calls POST /crm/v3/objects/taxes on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

DESTRUCTIVE. Archive a batch of taxes by ID. Archive multiple taxes by their IDs in a single request. Taxes applied to quotes, invoices and orders. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/taxes/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create a batch of taxes. Create multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects. Taxes applied to quotes, invoices and orders. Calls POST /crm/v3/objects/taxes/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Read a batch of taxes by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. Taxes applied to quotes, invoices and orders. Calls POST /crm/v3/objects/taxes/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Update a batch of taxes by internal ID, or unique property values. Update multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk. Taxes applied to quotes, invoices and orders. Calls POST /crm/v3/objects/taxes/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Create or update a batch of taxes by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Taxes applied to quotes, invoices and orders. Calls POST /crm/v3/objects/taxes/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.write.

Search for taxes using specified criteria. Execute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters. Taxes applied to quotes, invoices and orders. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/taxes/search on api.hubapi.com. Requires the HubSpot scope crm.objects.line_items.read.

Create. Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls POST /crm/v3/objects/tickets on api.hubapi.com. Requires the HubSpot scope tickets.

DESTRUCTIVE. Archive a batch of tickets by ID. Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records). Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/tickets/batch/archive on api.hubapi.com. Requires the HubSpot scope tickets.

Create a batch of tickets. Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls POST /crm/v3/objects/tickets/batch/create on api.hubapi.com. Requires the HubSpot scope tickets.

Read a batch of tickets by internal ID, or unique property values. Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls POST /crm/v3/objects/tickets/batch/read on api.hubapi.com. Requires the HubSpot scope tickets.

Update a batch of tickets by internal ID, or unique property values. Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls POST /crm/v3/objects/tickets/batch/update on api.hubapi.com. Requires the HubSpot scope tickets.

Create or update a batch of tickets by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. Calls POST /crm/v3/objects/tickets/batch/upsert on api.hubapi.com. Requires the HubSpot scope tickets.

DESTRUCTIVE. Merge two tickets. Merge two tickets, combining them into one ticket record. Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. There is NO un-merge. HubSpot cannot separate merged records afterwards. Requires confirm="merge-records-irreversibly" - that exact string. A boolean is not a control against a model that has already decided to call the tool. Calls POST /crm/v3/objects/tickets/merge on api.hubapi.com. Requires the HubSpot scope tickets.

Search for tickets. Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). Tickets are Service Hub support cases. The `tickets` scope is a single scope covering both reading and writing them - there is no separate tickets.read. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/tickets/search on api.hubapi.com. Requires the HubSpot scope tickets.

Create. Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls POST /crm/v3/objects/users on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

DESTRUCTIVE. Archive a batch of users by ID. Archive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. The inverse is the batch create on the same object family. Calls POST /crm/v3/objects/users/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

Create a batch of users. Create multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls POST /crm/v3/objects/users/batch/create on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

Read a batch of users by internal ID, or unique property values. Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls POST /crm/v3/objects/users/batch/read on api.hubapi.com. Requires the HubSpot scope crm.objects.users.read.

Update a batch of users by internal ID, or unique property values. Update multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls POST /crm/v3/objects/users/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

Create or update a batch of users by unique property values. Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. Calls POST /crm/v3/objects/users/batch/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.users.write.

Search for users based on specified criteria. Execute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request. The CRM user object - one record per HubSpot seat, used to attribute ownership. Reading it is how a user id in an owner field is resolved to a person. THE ID-DISCOVERY WORKHORSE. HubSpot's Search API takes a filterGroups array (groups are OR-ed, filters inside a group are AND-ed), a sorts array and a properties array, and returns matching records with their ids. Filter operators are EQ, NEQ, LT, LTE, GT, GTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY, CONTAINS_TOKEN and NOT_CONTAINS_TOKEN. It is how an agent turns 'the deal for Acme' into a deal id, and almost every write in this connector needs an id that only a search or a list read can supply. Results are capped at 10,000 records and paged with `after`. Calls POST /crm/v3/objects/users/search on api.hubapi.com. Requires the HubSpot scope crm.objects.users.read.

Create a pipeline. Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls POST /crm/v3/pipelines/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Create a pipeline stage. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls POST /crm/v3/pipelines/{objectType}/{pipelineId}/stages on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Create a property. Create and return a copy of a new property for the specified object type. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls POST /crm/v3/properties/{objectType} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Archive a batch of properties. Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. The inverse is the batch create on the same object family. Calls POST /crm/v3/properties/{objectType}/batch/archive on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Create a batch of properties. Create a batch of properties using the same rules as when creating an individual property. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls POST /crm/v3/properties/{objectType}/batch/create on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Read a batch of properties. Read a provided list of properties. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls POST /crm/v3/properties/{objectType}/batch/read on api.hubapi.com. Requires the HubSpot scopes crm.schemas.custom.read, crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets.

Create a property group. Create and return a copy of a new property group. Properties are the FIELD DEFINITIONS on an object type - name, type, options, group. Reading them is what turns an opaque property key in a record into something an agent can describe, and what tells a write which keys are legal. Property reads are the highest-value diagnostic read in this connector. Calls POST /crm/v3/properties/{objectType}/groups on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

DESTRUCTIVE. Remove associations. Batch delete associations for objects Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. The inverse is the batch create on the same object family. Calls POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Create Default Associations. Create the default (most generic) association type between two object types Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Associate records (labelled). Batch create associations for objects Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

DESTRUCTIVE. Delete Specific Labels. Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Retrieve associations. Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise. Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls POST /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.read, crm.objects.companies.read, crm.objects.deals.read, tickets, crm.objects.line_items.read, crm.objects.quotes.read, crm.objects.custom.read.

Report high usage. Requests a report of all objects in the portal which have a high usage of associations Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls POST /crm/v4/associations/usage/high-usage-report/{userId} on api.hubapi.com. Requires the HubSpot scope crm.objects.contacts.write.

Upload file. Upload a single file with content specified in request body. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls POST /files/v3/files on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Import file from URL. Asynchronously imports the file at the given URL into the file manager. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls POST /files/v3/files/import-from-url/async on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Create folder. Creates a folder. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls POST /files/v3/folders on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Update folder properties. Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls POST /files/v3/folders/update/async on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Send event data (single). Send a single instance of event data to a specified event type. Timeline events are the app-authored entries on a record's activity feed. Calls POST /integrators/timeline/v3/events on api.hubapi.com. Requires the HubSpot scope timeline.write.

Create multiple events. Batch create multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via `objectPropertyName`, this call will also attempt to updates those properties, or add them if they don't exist. Timeline events are the app-authored entries on a record's activity feed. Calls POST /integrators/timeline/v3/events/batch/create on api.hubapi.com. Requires the HubSpot scope timeline.write.

Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

DESTRUCTIVE. Delete a batch of campaigns. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. The inverse is the batch create on the same object family. Calls POST /marketing/v3/campaigns/batch/archive on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Create a batch of campaigns. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns/batch/create on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Read a batch of campaigns. 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. If duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns/batch/read on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.read.

Update a batch of campaigns. 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. Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns/batch/update on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Add budget item. Add a new budget item to the campaign Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns/{campaignGuid}/budget on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Create campaign spend item. Create a new campaign spend item Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls POST /marketing/v3/campaigns/{campaignGuid}/spend on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Create an A/B test variation of a marketing email. 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. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/ab-test/create-variation on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Reset the draft version. Resets the draft back to a copy of the live object. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/{emailId}/draft/reset on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Publish or send a marketing email. If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/{emailId}/publish on api.hubapi.com. Requires the HubSpot scope marketing-email.

Restore a revision of a marketing email. Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Restore a revision of a marketing email to DRAFT state. 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. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Unpublish or cancel a marketing email. 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. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/{emailId}/unpublish on api.hubapi.com. Requires the HubSpot scope marketing-email.

Clone a marketing email. This will create a duplicate email with the same properties as the original, with the exception of a unique ID. Marketing email assets: drafts, clones, A/B variations, revisions and statistics. Nothing here SENDS to an address the caller names - the publish and send-to-list operations act on an audience HubSpot already holds. Calls POST /marketing/v3/emails/clone on api.hubapi.com. Requires the HubSpot scope marketing.email.write.

Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls POST /marketing/v3/forms on api.hubapi.com. Requires the HubSpot scope forms.

Record Participants by ContactId with Marketing Event External Ids. Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Record Participants by Email with Marketing Event External Ids. Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

DESTRUCTIVE. Delete Multiple Marketing Events by ObjectId. Deletes multiple Marketing Events from the portal based on their objectId, if they exist. Responses: 204: Returned if all specified Marketing Events were successfully deleted. 207: Returned if some objectIds did not correspond to any existing Marketing Events. Marketing events - webinars and similar - and their attendance state. The inverse is the batch create on the same object family. Calls POST /marketing/v3/marketing-events/batch/archive on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Update Multiple Marketing Events by ObjectId. Updates multiple Marketing Events on the portal based on their objectId, if they exist. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/batch/update on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Record Participants by ContactId with Marketing Event Object Id. Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Record Participants by Email with Marketing Event Object Id. Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Create a marketing event. Creates a new marketing event in HubSpot Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Record a subscriber state by contact email. 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 existing contacts. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Record a subscriber state by contact ID. 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. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Mark a marketing event as cancelled. Mark a marketing event as cancelled. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/{externalEventId}/cancel on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Mark a marketing event as completed. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/{externalEventId}/complete on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Delete Multiple Marketing Events by External Ids. Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId. Only Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/delete on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Create or Update Multiple Marketing Events. 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. Only Marketing Events originally created by the same app can be updated. Marketing events - webinars and similar - and their attendance state. Calls POST /marketing/v3/marketing-events/events/upsert on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Create a new calendar meeting event. Create a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /scheduler/v3/meetings/calendar on api.hubapi.com. Requires the HubSpot scope meetings-write.

Book a meeting. Book a meeting for a specified meeting page. Meeting engagements on a record's timeline. Gated on the contacts scope. Calls POST /scheduler/v3/meetings/meeting-links/book on api.hubapi.com. Requires the HubSpot scope meetings-write.

The shared inbox: threads, messages, actors and channels. Replies go into an existing thread whose participants HubSpot already chose, which is why they ship where a caller-addressed email would not. Calls PUT /conversations/conversations/v3/threads/{threadId}/assignee on api.hubapi.com. Requires the HubSpot scope conversations.write.

Update association label. Update an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship. Association LABELS and definitions: the vocabulary of association types the portal allows, and which pairs of object types may be associated at all. Calls PUT /crm/associations/v4/{fromObjectType}/{toObjectType}/labels on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Recurring Commerce Hub subscriptions. Calls PUT /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Recurring Commerce Hub subscriptions. Calls PUT /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Add Records to a List. Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/memberships/add on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Add and/or Remove Records from a List. Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/memberships/add-and-remove on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Add All Records from a Source List to a Destination List. Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processi... Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/memberships/add-from/{sourceListId} on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Remove Records from a List. Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/memberships/remove on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Restore a List. Restore a previously deleted list by **ILS list ID**. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/restore on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Schedule or update the conversion of a list to static. Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/schedule-conversion on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

DESTRUCTIVE. Update List Filter Definition. Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/update-list-filters on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Update List Name. Update the name of a list. The name must be globally unique relative to all other public lists in the portal. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/{listId}/update-list-name on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Moves a folder. This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/folders/{folderId}/move/{newParentFolderId} on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Rename a folder. Renames the given folderId with a new name. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/folders/{folderId}/rename on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Moves a list to a given folder. Given a list and a folder, the list will be moved to that folder. Lists are HubSpot's saved segments - static and active. List membership reads produce the record ids a campaign or a bulk update operates on. Calls PUT /crm/v3/lists/folders/move-list on api.hubapi.com. Requires the HubSpot scopes crm.lists.read, crm.lists.write.

Replace a pipeline. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls PUT /crm/v3/pipelines/{objectType}/{pipelineId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Replace a pipeline stage. Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response. Pipelines and their stages: the ordered states a deal or ticket moves through. A deal update that sets dealstage needs a stage id, and this is the only thing that produces one. Calls PUT /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} on api.hubapi.com. Requires the HubSpot scopes crm.schemas.contacts.write, crm.schemas.companies.write, crm.schemas.deals.write, crm.schemas.quotes.write, crm.schemas.custom.write, tickets.

Update a validation rule for a specific property and rule type, allowing customization of property value constraints. Update a specific validation rule for a property identified by its name and rule type. Per-property validation rules - what HubSpot will reject before a write is attempted. Calls PUT /crm/v3/property-validations/{objectTypeId}/{propertyName}/rule-type/{ruleType} on api.hubapi.com. Requires the HubSpot scope tickets.

Associate records (default). Create the default (most generic) association type between two object types Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls PUT /crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Associate records (labelled). Set association labels between two records. Associations are the links between records - which contacts are on a deal, which company a ticket belongs to. Associations v4 is the current API. A write whose ids came from nowhere is unusable, so the association reads are the ones that make the object reads composable. Calls PUT /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} on api.hubapi.com. Requires the HubSpot scopes crm.objects.contacts.write, crm.objects.companies.write, crm.objects.deals.write, tickets, crm.objects.line_items.write, crm.objects.quotes.write, crm.objects.custom.write.

Replace file. 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. The file manager. Files are what a note, email or quote attaches. NOTE: the signed-URL read is deliberately absent - its response is a pre-authenticated URL that grants the bearer the file with no further credential, and no Agentic Fabriq redactor covers a URL. Calls PUT /files/v3/files/{fileId} on api.hubapi.com. Requires the HubSpot scope files.ui_hidden.write.

Add asset association. 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 events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows. For other asset types, it is recommended to manage your ass... Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls PUT /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Update budget item. Update a specific budget item by ID Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls PUT /marketing/v3/campaigns/{campaignGuid}/budget/{budgetId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Update campaign spend item. Update a specific campaign spend item by ID Marketing campaigns, the assets attached to them, their budget and their measured revenue. Calls PUT /marketing/v3/campaigns/{campaignGuid}/spend/{spendId} on api.hubapi.com. Requires the HubSpot scope marketing.campaigns.write.

Update a form definition. Update all fields of a hubspot form definition. Marketing forms and their field definitions. Reading a form tells an agent which fields a submission may carry. Calls PUT /marketing/v3/forms/{formId} on api.hubapi.com. Requires the HubSpot scope forms.

Associate a list with a marketing event. Associates a list with a marketing event by external account id, external event id, and ILS list id Marketing events - webinars and similar - and their attendance state. Calls PUT /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Associate a list with a marketing event. Associates a list with a marketing event by marketing event id and ILS list id Marketing events - webinars and similar - and their attendance state. Calls PUT /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.

Create or update a marketing event. 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. Marketing events - webinars and similar - and their attendance state. Calls PUT /marketing/v3/marketing-events/events/{externalEventId} on api.hubapi.com. Requires the HubSpot scope crm.objects.marketing_events.write.