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