Skip to content

HubSpot: Deals schemas

32 HubSpot schemas with complete fields and constraints.

← Deals operations · All schemas

Archive a batch of deals by ID — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputsarrayRequired within parentAn array of SimplePublicObjectId objects, each representing a unique identifier for a CRM object. This is used to specify the objects that are part of the batch operation.
inputs[]ModelEach itemExpand Archive a batch of deals by ID — request body — body inputs item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Archive a batch of deals by ID — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentThe unique ID of the object.

Create a batch of deals — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations for a single object to be created.
inputs[]ModelEach itemExpand Create a batch of deals — request body — body inputs item

Referenced models: Create a batch of deals — request body — body inputs item

Create a batch of deals — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRootAn input object that contains a collection of objects to be created together in a batch.
associationsarrayRequired within parentAn array of associations that define the relationships between the CRM objects being created and other objects. Each association is specified using the PublicAssociationsForObject schema.
associations[]ModelEach itemExpand Create — deals create Deal — request body — body associations item
objectWriteTraceIdstringOptionalAn identifier used for tracing the creation or update request of the object.
propertiesobjectRequired within parentKey value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys

Referenced models: Create — deals create Deal — request body — body associations item

Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object

FieldTypePresenceDescription and constraints
$objectRootA public object batch response object
completedAtstringRequired within parentThe timestamp when the batch processing was completed, in ISO 8601 format.
Format: date-time
linksobjectOptionalAn object containing relevant links related to the batch request.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe timestamp when the batch request was initially made, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of SimplePublicObject items representing the results of the batch operation.
results[]ModelEach itemExpand Create — deals create Deal — response body
startedAtstringRequired within parentThe timestamp when the batch processing began, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe status of the batch processing request. The expected value is "COMPLETE".
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create — deals create Deal — response body

Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object With Errors

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAtstringRequired within parentThe timestamp when the batch process was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of StandardError instances detailing any errors that occurred during the batch operation.
errors[]ModelEach itemExpand Remove associations — response body — errors item
linksobjectOptionalAn object containing relevant links related to the batch request.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors encountered during the batch process.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe timestamp when the batch process was initiated, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of SimplePublicObject instances representing the successful results of the batch operation.
results[]ModelEach itemExpand Create — deals create Deal — response body
startedAtstringRequired within parentThe timestamp when the batch process began execution, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe status of the batch processing request - "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove associations — response body — errors item, Create — deals create Deal — response body

Create or update a batch of deals by unique property values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInputUpsert objects, each containing the data for a single object to be created or updated. This is a required field.
inputs[]ModelEach itemExpand Create or update a batch of deals by unique property values — request body — body inputs item

Referenced models: Create or update a batch of deals by unique property values — request body — body inputs item

Create or update a batch of deals by unique property values — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRootRepresents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
idstringRequired within parentThe unique ID of the object.
idPropertystringOptionalThe name of a property whose values are unique for this object
objectWriteTraceIdstringOptionalAn identifier for tracing the creation request.
propertiesobjectRequired within parentKey value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys

Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object that has either been created or updated (upserted)
archivedbooleanRequired within parentWhether the object is archived.
archivedAtstringOptionalThe timestamp when the object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe timestamp when the object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique ID of the object.
newbooleanRequired within parentWhether the object is created.
objectWriteTraceIdstringOptionalAn identifier used for tracing the creation or update request of the object.
propertiesobjectRequired within parentKey value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalKey-value pairs representing the properties of the object along with their history.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — deals get Deal — response body — properties With History value item
updatedAtstringRequired within parentThe timestamp when the object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalThe URL associated with this object.
warningsarrayOptionalA list of warnings related to this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Read — deals get Deal — response body — warnings item

Referenced models: Read — deals get Deal — response body — warnings item, Read — deals get Deal — response body — properties With History value item

Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Upsert Object

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAtstringRequired within parentThe timestamp when the batch process was completed, in ISO 8601 format.
Format: date-time
linksobjectOptionalAn object containing relevant links related to the batch request.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe timestamp when the batch process was initiated, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of objects representing the results of the batch upsert operation. Each object includes details about the created or updated CRM object.
results[]ModelEach itemExpand Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe timestamp when the batch process began execution, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe status of the batch processing request. The expected value is "COMPLETE".
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Upsert Object With Errors

FieldTypePresenceDescription and constraints
$objectRootRepresents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAtstringRequired within parentThe timestamp when the batch process was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of errors that occurred during the batch operation. Each error is represented as a StandardError object.
errors[]ModelEach itemExpand Remove associations — response body — errors item
linksobjectOptionalAn object containing relevant links related to the batch request.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors encountered during the batch process.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe timestamp when the batch process was initiated, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of objects representing the results of the upsert operation. Each object is a SimplePublicUpsertObject.
results[]ModelEach itemExpand Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe timestamp when the batch process began execution, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove associations — response body — errors item, Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create — deals create Deal — request body — body

FieldTypePresenceDescription and constraints
$objectRootIs the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associationsarrayRequired within parentAn array of associations that link this object to other objects. Each association is defined by a PublicAssociationsForObject schema.
associations[]ModelEach itemExpand Create — deals create Deal — request body — body associations item
propertiesobjectRequired within parentKey-value pairs for setting properties for the new object.
Additional keys: see wildcard field
properties.*stringAdditional keys

Referenced models: Create — deals create Deal — request body — body associations item

Create — deals create Deal — request body — body associations item

FieldTypePresenceDescription and constraints
$objectRootRepresents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
toModelRequired within parentExpand Archive a batch of deals by ID — request body — body inputs item
typesarrayRequired within parentAn array of association specifications, each detailing a specific type of association between the objects.
types[]ModelEach itemExpand Associate records (labelled) — associations update Association Labeled — request body — body item

Referenced models: Archive a batch of deals by ID — request body — body inputs item, Associate records (labelled) — associations update Association Labeled — request body — body item

Create — deals create Deal — response body

FieldTypePresenceDescription and constraints
$objectRootA simple public object.
archivedbooleanRequired within parentWhether the object is archived.
archivedAtstringOptionalThe timestamp when the object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe timestamp when the object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique ID of the object.
objectWriteTraceIdstringOptionalAn identifier used for tracing the creation or update request of the object.
propertiesobjectRequired within parentKey-value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalKey-value pairs representing the properties of the object along with their history.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — deals get Deal — response body — properties With History value item
updatedAtstringRequired within parentThe timestamp when the object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalA string representing the URL for this object.
warningsarrayOptionalAn array of warnings related to this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Read — deals get Deal — response body — warnings item

Referenced models: Read — deals get Deal — response body — warnings item, Read — deals get Deal — response body — properties With History value item

GDPR Delete — deals gdpr Delete — request body — body

FieldTypePresenceDescription and constraints
$objectRootAn input that contains the information required to process a public GDPR data deletion request.
idPropertystringOptionalThe name of a property whose values are unique for this object
objectIdstringRequired within parentThe unique ID of the object.

List associations — deals get Associations By To Object Type — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
pagingModelOptionalExpand Get all tax rates — response body — paging
resultsarrayRequired within parentAn array of objects, each representing an association with multiple labels. Each object includes details of the associated object and the labels applied to it.
results[]ModelEach itemExpand List associations — deals get Associations By To Object Type — response body — results item

Referenced models: Get all tax rates — response body — paging, List associations — deals get Associations By To Object Type — response body — results item

List associations — deals get Associations By To Object Type — response body — results item

FieldTypePresenceDescription and constraints
$objectRootRepresents an object that is associated with multiple other objects, with optional context.
associationTypesarrayRequired within parentAn array of association specifications, each including a label. Each item in the array is an object that defines the type and category of the association.
associationTypes[]ModelEach itemExpand List associations — deals get Associations By To Object Type — response body — results item association Types item
toObjectIdstringRequired within parentTarget unique ID of the object.

Referenced models: List associations — deals get Associations By To Object Type — response body — results item association Types item

List associations — deals get Associations By To Object Type — response body — results item association Types item

FieldTypePresenceDescription and constraints
$objectRootDefines the type, direction, and details of the relationship between two CRM objects.
categorystringRequired within parentAssociation category. Can be HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED or WORK
Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeIdstringOptionalA string representing the object type ID from which the association originates.
labelstringOptionalA string representing the label for the association, which is optional.
toObjectTypeIdstringOptionalA string representing the object type ID to which the association points.
typeIdJSONRequired within parent
typeId (anyOf 1)integerAlternativeAn integer representing the unique identifier for the association type.
Format: int32
typeId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — deals get Deals — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
pagingModelOptionalExpand Get all tax rates — response body — paging
resultsarrayRequired within parentAn array of SimplePublicObjectWithAssociations objects, each representing a CRM object along with its associated data.
results[]ModelEach itemExpand Read — deals get Deal — response body

Referenced models: Get all tax rates — response body — paging, Read — deals get Deal — response body

Read a batch of deals by internal ID, or unique property values — request body — body

FieldTypePresenceDescription and constraints
$objectRootSpecifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idPropertystringOptionalWhen using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputsarrayRequired within parentAn array of SimplePublicObjectId objects, each representing an object to be read in the batch operation.
inputs[]ModelEach itemExpand Archive a batch of deals by ID — request body — body inputs item
propertiesarrayRequired within parentKey-value pairs for setting properties for the new object.
properties[]stringEach item
propertiesWithHistoryarrayRequired within parentKey-value pairs for setting properties for the new object and their histories.
propertiesWithHistory[]stringEach item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Read — deals get Deal — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archivedbooleanRequired within parentWhether the object is archived.
archivedAtstringOptionalThe timestamp when the object was archived, in ISO 8601 format.
Format: date-time
associationsobjectOptionalA list defining relationships with other objects.
Additional keys: see wildcard field
associations.*ModelAdditional keysExpand Read — deals get Deal — response body — associations value
createdAtstringRequired within parentThe timestamp when the object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique ID of the object.
objectWriteTraceIdstringOptionalAn identifier used for tracing the creation or update request of the object.
propertiesobjectRequired within parentKey value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalKey-value pairs representing the properties of the object along with their history.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — deals get Deal — response body — properties With History value item
updatedAtstringRequired within parentThe timestamp when the object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalThe URL link to access this object.
warningsarrayOptionalA list of warnings associated with this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Read — deals get Deal — response body — warnings item

Referenced models: Read — deals get Deal — response body — associations value, Read — deals get Deal — response body — warnings item, Read — deals get Deal — response body — properties With History value item

Read — deals get Deal — response body — associations value

FieldTypePresenceDescription and constraints
$objectRootRepresents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
pagingModelOptionalExpand Return all draft tables — response body — paging
resultsarrayRequired within parentAn array of associated IDs, where each ID represents a linked object. The items in this array are of the type AssociatedId.
results[]ModelEach itemExpand Read — deals get Deal — response body — associations value results item

Referenced models: Read — deals get Deal — response body — associations value results item, Return all draft tables — response body — paging

Read — deals get Deal — response body — associations value results item

FieldTypePresenceDescription and constraints
$objectRootContains the id and type of an association
idstringRequired within parentThe ID for the association type.
typestringRequired within parentThe type of association.

Read — deals get Deal — response body — properties With History value item

FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalThe unique ID of the property.
sourceLabelstringOptionalA human-readable label.
sourceTypestringRequired within parentThe property type.
timestampstringRequired within parentThe timestamp when the property was updated, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who last updated the property.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe property value.

Read — deals get Deal — response body — warnings item

FieldTypePresenceDescription and constraints
$objectRootRepresents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
categorystringRequired within parentA string representing the category of the warning.
contextobjectRequired within parentAn object providing additional context about the warning, with keys and values as strings.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.

Search for deals using various filters and criteria to retrieve specific records — request body — body

FieldTypePresenceDescription and constraints
$objectRootDescribes a search request
afterstringRequired within parentA paging cursor token for retrieving subsequent pages.
filterGroupsarrayRequired within parentUp to 6 groups of filters defining additional query criteria.
filterGroups[]ModelEach itemExpand Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item
limitintegerRequired within parentThe maximum results to return, up to 200 objects.
Format: int32
propertiesarrayRequired within parentA list of property names to include in the response.
properties[]stringEach item
querystringOptionalThe search query string, up to 3000 characters.
sortsarrayRequired within parentSpecifies sorting order based on object properties.
sorts[]stringEach item

Referenced models: Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item

Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item

FieldTypePresenceDescription and constraints
$objectRootRepresents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filtersarrayRequired within parentAn array of filter objects that define the criteria for filtering. Each filter specifies conditions such as property name, value, and operator.
filters[]ModelEach itemExpand Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item filters item

Referenced models: Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item filters item

Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item filters item

FieldTypePresenceDescription and constraints
$objectRootDefines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValuestringOptionalThe upper boundary value when using ranged-based filters.
operatorstringRequired within parentThe operator that defines the type of comparison to be made. Valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'.
One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyNamestringRequired within parentThe name of the property to apply the filter to.
valuestringOptionalThe value to match against the property.
valuesarrayOptionalThe values to match against the property.
values[]stringEach item

Search for deals using various filters and criteria to retrieve specific records — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a list of simple objects returned from an API request, along with the total count of objects available.
pagingModelOptionalExpand Return all draft tables — response body — paging
resultsarrayRequired within parentAn array of SimplePublicObject items, each representing a CRM object with its basic properties.
results[]ModelEach itemExpand Create — deals create Deal — response body
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe number of available results
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Return all draft tables — response body — paging, Create — deals create Deal — response body

Update a batch of deals by internal ID, or unique property values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a CRM object to be updated.
inputs[]ModelEach itemExpand Update a batch of deals by internal ID, or unique property values — request body — body inputs item

Referenced models: Update a batch of deals by internal ID, or unique property values — request body — body inputs item

Update a batch of deals by internal ID, or unique property values — request body — body inputs item

FieldTypePresenceDescription and constraints
$objectRootContains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
idstringRequired within parentThe id to be updated. This can be the object id, or the unique property value of the idProperty property
idPropertystringOptionalThe name of a property whose values are unique for this object
objectWriteTraceIdstringOptionalA unique identifier for tracing the request.
propertiesobjectRequired within parentKey-value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys

Update — deals update Deal — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the input required to update a CRM object, containing an object with property names and their corresponding values.
propertiesobjectRequired within parentKey value pairs representing the properties of the object.
Additional keys: see wildcard field
properties.*stringAdditional keys

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.