{ "openapi" : "3.0.1", "info" : { "title" : "Associations", "description" : "Basepom for all HubSpot Projects", "version" : "v4", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" }, "x-hubspot-api-use-case" : "When an existing contact has moved to a new company, update their associated company to keep your CRM up to date.", "x-hubspot-related-documentation" : [ { "name" : "Associations guide", "url" : "https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4" } ], "x-hubspot-introduction" : "Use the associations API to create, retrieve, update, or delete associations between records, or between records and activities. " }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" }, { "name" : "Batch" }, { "name" : "Report" } ], "paths" : { "/crm/v4/associations/usage/high-usage-report/{userId}" : { "post" : { "tags" : [ "Report" ], "summary" : "Report high usage", "description" : "Requests a report of all objects in the portal which have a high usage of associations", "operationId" : "post-/crm/v4/associations/usage/high-usage-report/{userId}_request", "parameters" : [ { "name" : "userId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportCreationResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive" : { "post" : { "tags" : [ "Batch" ], "summary" : "Remove associations", "description" : "Batch delete associations for objects", "operationId" : "post-/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive_archive", "parameters" : [ { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiArchive" }, "example" : null } }, "required" : true }, "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default" : { "post" : { "tags" : [ "Batch" ], "summary" : " Create Default Associations", "description" : "Create the default (most generic) association type between two object types", "operationId" : "post-/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default_createDefault", "parameters" : [ { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputPublicDefaultAssociationMultiPost" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create" : { "post" : { "tags" : [ "Batch" ], "summary" : "Associate records (labelled)", "description" : "Batch create associations for objects", "operationId" : "post-/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create_create", "parameters" : [ { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiPost" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseLabelsBetweenObjectPair" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseLabelsBetweenObjectPairWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive" : { "post" : { "tags" : [ "Batch" ], "summary" : "Delete Specific Labels", "description" : "Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects", "operationId" : "post-/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive_archiveLabels", "parameters" : [ { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiPost" }, "example" : null } }, "required" : true }, "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read" : { "post" : { "tags" : [ "Batch" ], "summary" : "Retrieve associations", "description" : "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.", "operationId" : "post-/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read_getPage", "parameters" : [ { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputPublicFetchAssociationsBatchRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponsePublicAssociationMultiWithLabel" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponsePublicAssociationMultiWithLabelWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { "put" : { "tags" : [ "Basic" ], "summary" : "Associate records (default)", "description" : "Create the default (most generic) association type between two object types", "operationId" : "put-/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_createDefault", "parameters" : [ { "name" : "fromObjectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "fromObjectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve all associations by object type", "description" : "Retrieve all associations between a specific record and an object type. Limit 500 per call.", "operationId" : "get-/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}_getPage", "parameters" : [ { "name" : "objectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 500 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { "put" : { "tags" : [ "Basic" ], "summary" : "Associate records (labelled)", "description" : "Set association labels between two records.", "operationId" : "put-/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_create", "parameters" : [ { "name" : "objectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpec" } }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LabelsBetweenObjectPair" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "summary" : "Delete associations between two records", "description" : "deletes all associations between two records.", "operationId" : "delete-/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_archive", "parameters" : [ { "name" : "objectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } } }, "components" : { "schemas" : { "AssociationSpec" : { "required" : [ "associationCategory", "associationTypeId" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the specific type of association.", "format" : "int32", "example" : null } }, "description" : "Defines the type, direction, and details of the relationship between two CRM objects.", "example" : null }, "AssociationSpecWithLabel" : { "required" : [ "category", "typeId" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The category of the association, such as HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED.", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "label" : { "type" : "string", "description" : "A label describing the association between two objects.", "example" : null }, "typeId" : { "type" : "integer", "description" : "The unique identifier for the type of association.", "format" : "int32", "example" : null } }, "description" : "Defines the type, direction, and details of the relationship between two CRM objects.", "example" : null }, "BatchInputPublicAssociationMultiArchive" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationMultiArchive" } } }, "example" : null }, "BatchInputPublicAssociationMultiPost" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationMultiPost" } } }, "example" : null }, "BatchInputPublicDefaultAssociationMultiPost" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicDefaultAssociationMultiPost" } } }, "example" : null }, "BatchInputPublicFetchAssociationsBatchRequest" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicFetchAssociationsBatchRequest" } } }, "example" : null }, "BatchResponseLabelsBetweenObjectPair" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LabelsBetweenObjectPair" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch processing began, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseLabelsBetweenObjectPairWithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "numErrors" : { "type" : "integer", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LabelsBetweenObjectPair" } }, "startedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponsePublicAssociationMultiWithLabel" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationMultiWithLabel" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch processing began, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponsePublicAssociationMultiWithLabelWithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "numErrors" : { "type" : "integer", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationMultiWithLabel" } }, "startedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponsePublicDefaultAssociation" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors encountered during the batch processing.", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicDefaultAssociation" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "description" : "The response returned after performing a batch operation on associations.", "example" : null }, "CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel" } } }, "example" : null }, "DateTime" : { "required" : [ "dateOnly", "timeZoneShift", "value" ], "type" : "object", "properties" : { "dateOnly" : { "type" : "boolean", "description" : "Indicates whether the DateTime value represents only a date without a time component.", "example" : null }, "timeZoneShift" : { "type" : "integer", "description" : "The integer value representing the shift in minutes from UTC for the DateTime value.", "format" : "int32", "example" : null }, "value" : { "type" : "integer", "description" : "The integer value representing a specific point in time.", "format" : "int64", "example" : null } }, "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "further information about the error", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "example" : null }, "LabelsBetweenObjectPair" : { "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], "type" : "object", "properties" : { "fromObjectId" : { "type" : "string", "description" : "The ID of the source object in the association.", "example" : null }, "fromObjectTypeId" : { "type" : "string", "description" : "The type ID of the source object in the association.", "example" : null }, "labels" : { "type" : "array", "description" : "An array of labels associated with the relationship between the objects.", "example" : null, "items" : { "type" : "string", "example" : null } }, "toObjectId" : { "type" : "string", "description" : "The ID of the target object in the association.", "example" : null }, "toObjectTypeId" : { "type" : "string", "description" : "The type ID of the target object in the association.", "example" : null } }, "description" : "The relationship descriptors applicable between two object types.", "example" : null }, "MultiAssociatedObjectWithLabel" : { "required" : [ "associationTypes", "toObjectId" ], "type" : "object", "properties" : { "associationTypes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpecWithLabel" } }, "toObjectId" : { "type" : "string", "description" : "The unique identifier for the target object in the association.", "example" : null } }, "description" : "Represents an object that is associated with multiple other objects, with optional context.", "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token for retrieving subsequent pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the next page results.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } }, "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "A paging cursor token for retrieving previous pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the previous pages' results.", "example" : null } }, "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response", "example" : null }, "PublicAssociationMultiArchive" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "to" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicObjectId" } } }, "example" : null }, "PublicAssociationMultiPost" : { "required" : [ "from", "to", "types" ], "type" : "object", "properties" : { "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "to" : { "$ref" : "#/components/schemas/PublicObjectId" }, "types" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpec" } } }, "example" : null }, "PublicAssociationMultiWithLabel" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "paging" : { "$ref" : "#/components/schemas/Paging" }, "to" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel" } } }, "example" : null }, "PublicDefaultAssociation" : { "required" : [ "associationSpec", "from", "to" ], "type" : "object", "properties" : { "associationSpec" : { "$ref" : "#/components/schemas/AssociationSpec" }, "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "to" : { "$ref" : "#/components/schemas/PublicObjectId" } }, "example" : null }, "PublicDefaultAssociationMultiPost" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "to" : { "$ref" : "#/components/schemas/PublicObjectId" } }, "example" : null }, "PublicFetchAssociationsBatchRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token used to retrieve the next set of results in a paginated response.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the object whose associations are being fetched.", "example" : null } }, "example" : null }, "PublicObjectId" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the object", "example" : null } }, "description" : "Contains the Id of a Public Object", "example" : null }, "ReportCreationResponse" : { "required" : [ "enqueueTime", "userEmail", "userId" ], "type" : "object", "properties" : { "enqueueTime" : { "$ref" : "#/components/schemas/DateTime" }, "userEmail" : { "type" : "string", "description" : "Email of the user", "example" : null }, "userId" : { "type" : "integer", "description" : "ID of the user", "format" : "int32", "example" : null } }, "example" : null }, "StandardError" : { "required" : [ "category", "context", "errors", "links", "message", "status" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The main category of the error.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Additional context-specific information related to the error.", "example" : null }, "errors" : { "type" : "array", "description" : "The detailed error objects.", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "id" : { "type" : "string", "description" : "A unique ID for the error instance.", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "URLs linking to documentation or resources associated with the error.", "example" : null }, "message" : { "type" : "string", "description" : "A human-readable string describing the error and possible remediation steps.", "example" : null }, "status" : { "type" : "string", "description" : "The HTTP status code associated with the error.", "example" : null }, "subCategory" : { "type" : "object", "properties" : { }, "description" : "A more specific error category within each main category.", "example" : null } }, "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.", "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "crm.objects.appointments.read" : "", "crm.objects.appointments.sensitive.read.v2" : "", "crm.objects.appointments.sensitive.write.v2" : "", "crm.objects.appointments.write" : "", "crm.objects.calls.read" : "", "crm.objects.carts.read" : "", "crm.objects.carts.write" : "", "crm.objects.commercepayments.read" : "", "crm.objects.commercepayments.write" : "", "crm.objects.companies.highly_sensitive.read.v2" : "", "crm.objects.companies.highly_sensitive.write.v2" : "", "crm.objects.companies.read" : "", "crm.objects.companies.sensitive.read.v2" : "", "crm.objects.companies.sensitive.write.v2" : "", "crm.objects.companies.write" : "", "crm.objects.contacts.highly_sensitive.read.v2" : "", "crm.objects.contacts.highly_sensitive.write.v2" : "", "crm.objects.contacts.read" : "", "crm.objects.contacts.sensitive.read.v2" : "", "crm.objects.contacts.sensitive.write.v2" : "", "crm.objects.contacts.write" : "", "crm.objects.courses.read" : "", "crm.objects.courses.write" : "", "crm.objects.custom.highly_sensitive.read.v2" : "", "crm.objects.custom.highly_sensitive.write.v2" : "", "crm.objects.custom.read" : "", "crm.objects.custom.sensitive.read.v2" : "", "crm.objects.custom.sensitive.write.v2" : "", "crm.objects.custom.write" : "", "crm.objects.deals.highly_sensitive.read.v2" : "", "crm.objects.deals.highly_sensitive.write.v2" : "", "crm.objects.deals.read" : "", "crm.objects.deals.sensitive.read.v2" : "", "crm.objects.deals.sensitive.write.v2" : "", "crm.objects.deals.write" : "", "crm.objects.emails.read" : "", "crm.objects.goals.read" : "", "crm.objects.goals.write" : "", "crm.objects.invoices.read" : "", "crm.objects.invoices.write" : "", "crm.objects.leads.read" : "", "crm.objects.leads.write" : "", "crm.objects.line_items.read" : "", "crm.objects.line_items.write" : "", "crm.objects.listings.read" : "", "crm.objects.listings.write" : "", "crm.objects.meetings.read" : "", "crm.objects.notes.read" : "", "crm.objects.orders.read" : "", "crm.objects.orders.write" : "", "crm.objects.partner-clients.read" : "", "crm.objects.partner-clients.write" : "", "crm.objects.partner-services.read" : "", "crm.objects.partner-services.write" : "", "crm.objects.products.read" : "", "crm.objects.products.write" : "", "crm.objects.projects.highly_sensitive.read" : "", "crm.objects.projects.highly_sensitive.write" : "", "crm.objects.projects.read" : "", "crm.objects.projects.sensitive.read" : "", "crm.objects.projects.sensitive.write" : "", "crm.objects.projects.write" : "", "crm.objects.quotes.read" : "", "crm.objects.quotes.write" : "", "crm.objects.services.read" : "", "crm.objects.services.write" : "", "crm.objects.subscriptions.read" : "", "crm.objects.subscriptions.write" : "", "crm.objects.tasks.read" : "", "crm.objects.users.read" : "", "crm.objects.users.write" : "", "e-commerce" : "", "media_bridge.read" : "", "oauth" : "", "tickets" : "", "tickets.highly_sensitive.v2" : "", "tickets.sensitive.v2" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }