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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
inputs | array | Required within parent | An 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the Id of a Public Object |
id | string | Required within parent | The unique ID of the object. |
Create a batch of deals — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations for a single object to be created. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An input object that contains a collection of objects to be created together in a batch. |
associations | array | Required within parent | An 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[] | Model | Each item | Expand Create — deals create Deal — request body — body associations item |
objectWriteTraceId | string | Optional | An identifier used for tracing the creation or update request of the object. |
properties | object | Required within parent | Key value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A public object batch response object |
completedAt | string | Required within parent | The timestamp when the batch processing was completed, in ISO 8601 format. Format: date-time |
links | object | Optional | An object containing relevant links related to the batch request. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | The timestamp when the batch request was initially made, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of SimplePublicObject items representing the results of the batch operation. |
results[] | Model | Each item | Expand Create — deals create Deal — response body |
startedAt | string | Required within parent | The timestamp when the batch processing began, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
completedAt | string | Required within parent | The timestamp when the batch process was completed, in ISO 8601 format. Format: date-time |
errors | array | Optional | An array of StandardError instances detailing any errors that occurred during the batch operation. |
errors[] | Model | Each item | Expand Remove associations — response body — errors item |
links | object | Optional | An object containing relevant links related to the batch request. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | The number of errors encountered during the batch process. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | The timestamp when the batch process was initiated, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of SimplePublicObject instances representing the successful results of the batch operation. |
results[] | Model | Each item | Expand Create — deals create Deal — response body |
startedAt | string | Required within parent | The timestamp when the batch process began execution, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInputUpsert objects, each containing the data for a single object to be created or updated. This is a required field. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
id | string | Required within parent | The unique ID of the object. |
idProperty | string | Optional | The name of a property whose values are unique for this object |
objectWriteTraceId | string | Optional | An identifier for tracing the creation request. |
properties | object | Required within parent | Key value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM object that has either been created or updated (upserted) |
archived | boolean | Required within parent | Whether the object is archived. |
archivedAt | string | Optional | The timestamp when the object was archived, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The timestamp when the object was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique ID of the object. |
new | boolean | Required within parent | Whether the object is created. |
objectWriteTraceId | string | Optional | An identifier used for tracing the creation or update request of the object. |
properties | object | Required within parent | Key value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | Key-value pairs representing the properties of the object along with their history. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Read — deals get Deal — response body — properties With History value item |
updatedAt | string | Required within parent | The timestamp when the object was last updated, in ISO 8601 format. Format: date-time |
url | string | Optional | The URL associated with this object. |
warnings | array | Optional | A list of warnings related to this object, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects. |
completedAt | string | Required within parent | The timestamp when the batch process was completed, in ISO 8601 format. Format: date-time |
links | object | Optional | An object containing relevant links related to the batch request. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | The timestamp when the batch process was initiated, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of objects representing the results of the batch upsert operation. Each object includes details about the created or updated CRM object. |
results[] | Model | Each item | Expand Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item |
startedAt | string | Required within parent | The timestamp when the batch process began execution, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing. |
completedAt | string | Required within parent | The timestamp when the batch process was completed, in ISO 8601 format. Format: date-time |
errors | array | Optional | An array of errors that occurred during the batch operation. Each error is represented as a StandardError object. |
errors[] | Model | Each item | Expand Remove associations — response body — errors item |
links | object | Optional | An object containing relevant links related to the batch request. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | The number of errors encountered during the batch process. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | The timestamp when the batch process was initiated, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of objects representing the results of the upsert operation. Each object is a SimplePublicUpsertObject. |
results[] | Model | Each item | Expand Create or update a batch of deals by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item |
startedAt | string | Required within parent | The timestamp when the batch process began execution, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Is 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. |
associations | array | Required within parent | An array of associations that link this object to other objects. Each association is defined by a PublicAssociationsForObject schema. |
associations[] | Model | Each item | Expand Create — deals create Deal — request body — body associations item |
properties | object | Required within parent | Key-value pairs for setting properties for the new object. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Referenced models: Create — deals create Deal — request body — body associations item
Create — deals create Deal — request body — body associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved. |
to | Model | Required within parent | Expand Archive a batch of deals by ID — request body — body inputs item |
types | array | Required within parent | An array of association specifications, each detailing a specific type of association between the objects. |
types[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A simple public object. |
archived | boolean | Required within parent | Whether the object is archived. |
archivedAt | string | Optional | The timestamp when the object was archived, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The timestamp when the object was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique ID of the object. |
objectWriteTraceId | string | Optional | An identifier used for tracing the creation or update request of the object. |
properties | object | Required within parent | Key-value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | Key-value pairs representing the properties of the object along with their history. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Read — deals get Deal — response body — properties With History value item |
updatedAt | string | Required within parent | The timestamp when the object was last updated, in ISO 8601 format. Format: date-time |
url | string | Optional | A string representing the URL for this object. |
warnings | array | Optional | An array of warnings related to this object, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An input that contains the information required to process a public GDPR data deletion request. |
idProperty | string | Optional | The name of a property whose values are unique for this object |
objectId | string | Required within parent | The unique ID of the object. |
List associations — deals get Associations By To Object Type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
paging | Model | Optional | Expand Get all tax rates — response body — paging |
results | array | Required within parent | An 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an object that is associated with multiple other objects, with optional context. |
associationTypes | array | Required within parent | An 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[] | Model | Each item | Expand List associations — deals get Associations By To Object Type — response body — results item association Types item |
toObjectId | string | Required within parent | Target 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines the type, direction, and details of the relationship between two CRM objects. |
category | string | Required within parent | Association category. Can be HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED or WORK Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK |
fromObjectTypeId | string | Optional | A string representing the object type ID from which the association originates. |
label | string | Optional | A string representing the label for the association, which is optional. |
toObjectTypeId | string | Optional | A string representing the object type ID to which the association points. |
typeId | JSON | Required within parent | |
typeId (anyOf 1) | integer | Alternative | An integer representing the unique identifier for the association type. Format: int32 |
typeId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List — deals get Deals — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
paging | Model | Optional | Expand Get all tax rates — response body — paging |
results | array | Required within parent | An array of SimplePublicObjectWithAssociations objects, each representing a CRM object along with its associated data. |
results[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies 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. |
idProperty | string | Optional | When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID. |
inputs | array | Required within parent | An array of SimplePublicObjectId objects, each representing an object to be read in the batch operation. |
inputs[] | Model | Each item | Expand Archive a batch of deals by ID — request body — body inputs item |
properties | array | Required within parent | Key-value pairs for setting properties for the new object. |
properties[] | string | Each item | |
propertiesWithHistory | array | Required within parent | Key-value pairs for setting properties for the new object and their histories. |
propertiesWithHistory[] | string | Each item |
Referenced models: Archive a batch of deals by ID — request body — body inputs item
Read — deals get Deal — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type. |
archived | boolean | Required within parent | Whether the object is archived. |
archivedAt | string | Optional | The timestamp when the object was archived, in ISO 8601 format. Format: date-time |
associations | object | Optional | A list defining relationships with other objects. Additional keys: see wildcard field |
associations.* | Model | Additional keys | Expand Read — deals get Deal — response body — associations value |
createdAt | string | Required within parent | The timestamp when the object was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique ID of the object. |
objectWriteTraceId | string | Optional | An identifier used for tracing the creation or update request of the object. |
properties | object | Required within parent | Key value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | Key-value pairs representing the properties of the object along with their history. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Read — deals get Deal — response body — properties With History value item |
updatedAt | string | Required within parent | The timestamp when the object was last updated, in ISO 8601 format. Format: date-time |
url | string | Optional | The URL link to access this object. |
warnings | array | Optional | A list of warnings associated with this object, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results. |
paging | Model | Optional | Expand Return all draft tables — response body — paging |
results | array | Required within parent | An array of associated IDs, where each ID represents a linked object. The items in this array are of the type AssociatedId. |
results[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the id and type of an association |
id | string | Required within parent | The ID for the association type. |
type | string | Required within parent | The type of association. |
Read — deals get Deal — response body — properties With History value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Property model that includes timestamp. |
sourceId | string | Optional | The unique ID of the property. |
sourceLabel | string | Optional | A human-readable label. |
sourceType | string | Required within parent | The property type. |
timestamp | string | Required within parent | The timestamp when the property was updated, in ISO 8601 format. Format: date-time |
updatedByUserId | JSON | Optional | |
updatedByUserId (anyOf 1) | integer | Alternative | The ID of the user who last updated the property. Format: int32 |
updatedByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value | string | Required within parent | The property value. |
Read — deals get Deal — response body — warnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning. |
category | string | Required within parent | A string representing the category of the warning. |
context | object | Required within parent | An object providing additional context about the warning, with keys and values as strings. Additional keys: see wildcard field |
context.* | string | Additional keys | |
message | string | Required within parent | A string containing the warning message. |
Search for deals using various filters and criteria to retrieve specific records — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a search request |
after | string | Required within parent | A paging cursor token for retrieving subsequent pages. |
filterGroups | array | Required within parent | Up to 6 groups of filters defining additional query criteria. |
filterGroups[] | Model | Each item | Expand Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item |
limit | integer | Required within parent | The maximum results to return, up to 200 objects. Format: int32 |
properties | array | Required within parent | A list of property names to include in the response. |
properties[] | string | Each item | |
query | string | Optional | The search query string, up to 3000 characters. |
sorts | array | Required within parent | Specifies sorting order based on object properties. |
sorts[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints. |
filters | array | Required within parent | An array of filter objects that define the criteria for filtering. Each filter specifies conditions such as property name, value, and operator. |
filters[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines 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. |
highValue | string | Optional | The upper boundary value when using ranged-based filters. |
operator | string | Required within parent | The 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 |
propertyName | string | Required within parent | The name of the property to apply the filter to. |
value | string | Optional | The value to match against the property. |
values | array | Optional | The values to match against the property. |
values[] | string | Each item |
Search for deals using various filters and criteria to retrieve specific records — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a list of simple objects returned from an API request, along with the total count of objects available. |
paging | Model | Optional | Expand Return all draft tables — response body — paging |
results | array | Required within parent | An array of SimplePublicObject items, each representing a CRM object with its basic properties. |
results[] | Model | Each item | Expand Create — deals create Deal — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The number of available results Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a CRM object to be updated. |
inputs[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties. |
id | string | Required within parent | The id to be updated. This can be the object id, or the unique property value of the idProperty property |
idProperty | string | Optional | The name of a property whose values are unique for this object |
objectWriteTraceId | string | Optional | A unique identifier for tracing the request. |
properties | object | Required within parent | Key-value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Update — deals update Deal — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the input required to update a CRM object, containing an object with property names and their corresponding values. |
properties | object | Required within parent | Key value pairs representing the properties of the object. Additional keys: see wildcard field |
properties.* | string | Additional keys |