Hubspotcrmconnector v1.0

/crm/v3/objects/carts/{cartId}

Move an Object identified by {cartId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cartid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/{commercePaymentId}

Move an Object identified by {commercePaymentId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Commercepaymentid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/{companyId}

Move an Object identified by {companyId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	The unique identifier of the company to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/{contactId}

Move an Object identified by {contactId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Contactid`	The unique identifier of the contact to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/{objectId}

Move an Object identified by {objectId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to archive, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/{dealId}

Move an Object identified by {dealId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dealid`	The unique identifier of the deal to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/{discountId}

Move an Object identified by {discountId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Discountid`	The unique identifier of the discount to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}

Move an Object identified by {feedbackSubmissionId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Feedbacksubmissionid`	The unique identifier of the feedback submission to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/{feeId}

Move an Object identified by {feeId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Feeid`	The unique identifier of the fee to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/{leadsId}

Move an Object identified by {leadsId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Leadsid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/{lineItemId}

Move an Object identified by {lineItemId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Lineitemid`	The unique identifier of the line item to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/{orderId}

Move an Object identified by {orderId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Orderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/{productId}

Move an Object identified by {productId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Productid`	The unique identifier of the product to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/{quoteId}

Move an Object identified by {quoteId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Quoteid`	The unique identifier of the quote to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/{taxId}

Move an Object identified by {taxId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Taxid`	The unique identifier of the tax to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/{ticketId}

Move an Object identified by {ticketId} to the recycling bin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ticketid`	The unique identifier of the ticket to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts

Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}

Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}

Set association labels between two records.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Toobjecttype`	The type of the target object, such as 'contact' or 'deal'.
`Toobjectid`	The unique identifier of the target object to associate.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Associationcategory`	The category of the association, for example 'HUBSPOT_DEFINED' or 'USER_DEFINED'.
`Associationtypeid`	The numeric identifier for the specific association type within the given category.

/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}

Create the default (most generic) association type between two object types

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Fromobjectid`	The unique identifier of the source object from which the association originates.
`Toobjecttype`	The type of the target object to associate with the source.
`Toobjectid`	The unique identifier of the target object to associate.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments

Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders

Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products

Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes

Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes

Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets

Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies

Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard companies is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts

Create a contact with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard contacts is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals

Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts

Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions

Create a feedback submission with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard feedback submissions is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees

Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads

Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items

Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}

deletes all associations between two records.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Toobjecttype`	The type of the target object whose association is being removed.
`Toobjectid`	The unique identifier of the target object to disassociate.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}

List all associations of an object by object type. Limit 500 per call.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`After`	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.
`Limit`	The maximum number of results to display per page.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts

Read a page of carts. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}

Read a page of objects. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments

Read a page of commerce payments. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads

Read a page of leads. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items

Read a page of line items. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders

Read a page of orders. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/payments

Read a page of payments. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products

Read a page of products. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes

Read a page of quotes. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes

Read a page of taxes. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets

Read a page of tickets. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/invoices

Read a page of invoices. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/subscriptions

Read a page of subscriptions. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies

Read a page of companies. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts

Read a page of contacts. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals

Read a page of deals. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts

Read a page of discounts. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions

Read a page of feedback submissions. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees

Read a page of fees. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/goal_targets

Read a page of goal targets. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of results to display per page.
`After`	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.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/{cartId}

Read an Object identified by {cartId}. {cartId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Cartid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/{commercePaymentId}

Read a payment identified by its ID. Include an optional properties query parameter to control the properties that are returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested payment, they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested payment, they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type.
`Commercepaymentid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/subscriptions/{subscriptionId}

Read an Object identified by {subscriptionId}. {subscriptionId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Subscriptionid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/{companyId}

Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Companyid`	The unique identifier of the company to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/{contactId}

Read an Object identified by {contactId}. {contactId} refers to the internal object ID. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Contactid`	The unique identifier of the contact to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/{objectId}

Read an Object identified by {objectId}. {objectId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/{dealId}

Read an Object identified by {dealId}. {dealId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Dealid`	The unique identifier of the deal to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/{discountId}

Read an Object identified by {discountId}. {discountId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Discountid`	The unique identifier of the discount to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}

Read an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Feedbacksubmissionid`	The unique identifier of the feedback submission to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/{feeId}

Read an Object identified by {feeId}. {feeId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Feeid`	The unique identifier of the fee to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/goal_targets/{goalTargetId}

Read an Object identified by {goalTargetId}. {goalTargetId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Goaltargetid`	The unique identifier of the goal target to read. Provide the ID as a string.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/{leadsId}

Read an Object identified by {leadsId}. {leadsId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Leadsid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/{lineItemId}

Read an Object identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Lineitemid`	The unique identifier of the line item to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/{orderId}

Read an Object identified by {orderId}. {orderId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Orderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/payments/{paymentsId}

Read an Object identified by {paymentsId}. {paymentsId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Paymentsid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/{productId}

Read an Object identified by {productId}. {productId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Productid`	The unique identifier of the product to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/{quoteId}

Read an Object identified by {quoteId}. {quoteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Quoteid`	The unique identifier of the quote to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/{taxId}

Read an Object identified by {taxId}. {taxId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Taxid`	The unique identifier of the tax to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/{ticketId}

Read an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Ticketid`	The unique identifier of the ticket to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/invoices/{invoiceId}

Read an Object identified by {invoiceId}. {invoiceId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Properties`	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Propertieswithhistory`	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
`Associations`	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
`Archived`	Whether to return only results that have been archived.
`Idproperty`	The name of a property whose values are unique for this object type
`Invoiceid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/{cartId}

Perform a partial update of an Object identified by {cartId}. {cartId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Cartid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/{commercePaymentId}

Perform a partial update of an Object identified by {commercePaymentId}. {commercePaymentId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Commercepaymentid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/{companyId}

Perform a partial update of an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Companyid`	The unique identifier of the company to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/{contactId}

Perform a partial update of an Object identified by {contactId}. {contactId} refers to the internal object ID. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Contactid`	The unique identifier of the contact to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/{objectId}

Perform a partial update of an Object identified by {objectId}. {objectId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Objectid`	The unique identifier of the object to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/{dealId}

Perform a partial update of an Object identified by {dealId}. {dealId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Dealid`	The unique identifier of the deal to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/{discountId}

Perform a partial update of an Object identified by {discountId}. {discountId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Discountid`	The unique identifier of the discount to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}

Perform a partial update of an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Feedbacksubmissionid`	The unique identifier of the feedback submission to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/{feeId}

Perform a partial update of an Object identified by {feeId}. {feeId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Feeid`	The unique identifier of the fee to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/{leadsId}

Perform a partial update of an Object identified by {leadsId}. {leadsId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Leadsid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/{lineItemId}

Perform a partial update of an Object identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Lineitemid`	The unique identifier of the line item to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/{orderId}

Perform a partial update of an Object identified by {orderId}. {orderId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Orderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/{productId}

Perform a partial update of an Object identified by {productId}. {productId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Productid`	The unique identifier of the product to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/{quoteId}

Perform a partial update of an Object identified by {quoteId}. {quoteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Quoteid`	The unique identifier of the quote to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/{taxId}

Perform a partial update of an Object identified by {taxId}. {taxId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Taxid`	The unique identifier of the tax to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/{ticketId}

Perform a partial update of an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	The name of a property whose values are unique for this object type
`Ticketid`	The unique identifier of the ticket to archive.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive

Remove the associations between all pairs of objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/batch/archive

Archive multiple carts at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/batch/archive

Archive multiple commerce payments at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/batch/archive

Archive multiple companies at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/batch/archive

Archive multiple contacts at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/batch/archive

Archive multiple deals at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/batch/archive

Archive multiple discounts at once by providing their unique identifiers.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/batch/archive

Archive multiple feedback submissions at once by providing their IDs. Use this to remove outdated or irrelevant feedback in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/batch/archive

Archive multiple fees at once by providing their IDs. Use this to remove outdated or incorrect fee records in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/batch/archive

Archive multiple leads at once by providing their IDs. Use this to remove outdated or unqualified leads in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/batch/archive

Archive multiple line items at once by providing their IDs. Use this to remove obsolete or incorrect line items in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/batch/archive

Archive multiple objects of a specific type at once by providing their IDs. Use this for bulk removal of any object type supported by the endpoint.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/batch/archive

Archive multiple orders at once by providing their IDs. Use this to remove outdated or canceled orders in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/batch/archive

Archive multiple products at once by providing their IDs. Use this to remove outdated or discontinued products in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/batch/archive

Archive multiple quotes at once by providing their IDs. Use this to remove expired or declined quotes in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/batch/archive

Archive multiple taxes at once by providing their IDs. Use this to remove outdated or incorrect tax records in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/batch/archive

Archive multiple tickets at once by providing their IDs. Use this to remove closed or irrelevant tickets in bulk.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create

Batch create associations for objects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default

Create the default (most generic) association type between two object types

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create

Associate all pairs of objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/batch/create

Create multiple carts in a single request. Use this to add several carts at once, each with its own set of properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/batch/create

Create multiple commerce payments in a single request. Use this to add several payment records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/batch/create

Create multiple companies in a single request. Use this to add several company records at once with their properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/batch/create

Create multiple contacts in a single request. Use this to add several contact records at once with their properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/batch/create

Create multiple deals in a single request. Use this to add several deal records at once with their properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/batch/create

Create multiple discounts in a single request. Use this to add several discount records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/batch/create

Create multiple feedback submissions in a single request. Use this to add several feedback records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/batch/create

Create multiple fees in a single request. Use this to add several fee records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/batch/create

Create multiple leads in a single request. Use this to add several lead records at once with their properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/batch/create

Create multiple line items in a single request. Use this to add several line item records at once with their properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/batch/create

Create multiple objects of a specified type in a single request. Use this to efficiently add several records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/batch/create

Create multiple orders in a single request. Use this to efficiently add several order records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/batch/create

Create multiple products in a single request. Use this to efficiently add several product records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/batch/create

Create multiple quotes in a single request. Use this to efficiently add several quote records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/batch/create

Create multiple taxes in a single request. Use this to efficiently add several tax records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/batch/create

Create multiple tickets in a single request. Use this to efficiently add several ticket records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/splits/batch/upsert

Create or replace deal splits for the specified deals. Use this to set the percentage splits for each deal, ensuring the percentages sum to 1.0.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive

Batch delete associations for objects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive

Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read

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.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read

Get the IDs of all {toObjectType} objects associated with those specified in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/batch/read

Retrieve a batch of carts by their internal IDs or unique property values. Use this to fetch multiple cart records efficiently.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each cart.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying carts if not using internal IDs.

/crm/v3/objects/commerce_payments/batch/read

Retrieve a batch of commerce payments by their internal IDs or unique property values. Use this to fetch multiple payment records efficiently.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each payment.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying payments if not using internal IDs.

/crm/v3/objects/companies/batch/read

Retrieve a batch of companies by their internal IDs or unique property values. Use this to fetch multiple company records efficiently.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each company.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying companies if not using internal IDs.

/crm/v3/objects/contacts/batch/read

Retrieve a batch of contacts by their internal IDs or unique property values. Use this to fetch multiple contact records efficiently.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/deals/splits/batch/read

Retrieve a batch of deal split objects by their associated deal internal IDs. Use this to get the split details for multiple deals at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/batch/read

Read a batch of deals by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/discounts/batch/read

Read a batch of discounts by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/feedback_submissions/batch/read

Read a batch of feedback submissions by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/fees/batch/read

Read a batch of fees by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/goal_targets/batch/read

Read a batch of goal targets by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/invoices/batch/read

Read a batch of invoices by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/leads/batch/read

Read a batch of leads by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/line_items/batch/read

Read a batch of line items by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/{objectType}/batch/read

Read a batch of objects of a specified type by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/orders/batch/read

Read a batch of orders by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/payments/batch/read

Read a batch of payments by internal ID or unique property values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/products/batch/read

Read a batch of products by their internal IDs or unique property values. Use this to efficiently retrieve multiple products in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/quotes/batch/read

Read a batch of quotes by their internal IDs or unique property values. Use this to efficiently retrieve multiple quotes in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/subscriptions/batch/read

Read a batch of subscriptions by their internal IDs or unique property values. Use this to efficiently retrieve multiple subscriptions in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/taxes/batch/read

Read a batch of taxes by their internal IDs or unique property values. Use this to efficiently retrieve multiple taxes in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/tickets/batch/read

Read a batch of tickets by their internal IDs or unique property values. Use this to efficiently retrieve multiple tickets in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Properties`	A list of property names to include in the response for each contact.
`Propertieswithhistory`	A list of property names for which to return historical values.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/carts/batch/update

Update a batch of carts with new property values. Use this to update multiple carts simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/commerce_payments/batch/update

Update a batch of commerce payments with new property values. Use this to update multiple commerce payments simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/companies/batch/update

Update a batch of companies by their internal IDs or unique property values. Use this to update multiple companies simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/batch/update

Update a batch of contacts by their internal IDs or unique property values. Use this to update multiple contacts simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/batch/update

Update a batch of deals by their internal IDs or unique property values. Use this to update multiple deals simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/batch/update

Update a batch of discounts with new property values. Use this to update multiple discounts simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/feedback_submissions/batch/update

Update a batch of feedback submissions by their internal IDs or unique property values. Use this to update multiple feedback submissions simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/batch/update

Update a batch of fees with new property values. Use this to update multiple fees simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/leads/batch/update

Update a batch of leads with new property values. Use this to update multiple leads simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/line_items/batch/update

Update a batch of line items by their internal IDs or unique property values. Use this to update multiple line items simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/batch/update

Update a batch of objects of a specified object type by their internal IDs or unique property values. Use this to update multiple objects of the same type simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/batch/update

Update multiple orders in a single request. Use this to efficiently apply changes to several orders at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/products/batch/update

Update multiple products by their internal IDs or unique property values. Ideal for bulk product updates.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/batch/update

Update multiple quotes by their internal IDs or unique property values. Use when you need to modify several quotes simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/taxes/batch/update

Update multiple tax objects in a batch. Suitable for applying changes to several tax records at once.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/tickets/batch/update

Update multiple tickets by their internal IDs or unique property values. Useful for bulk ticket modifications.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/extensions/cards-dev/{appId}

Defines a new card that will become active on an account when this app is installed.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	The ID of the app to which the card will belong. Provide the app ID from your developer account.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Title`	The title of the card to be displayed. Enter a descriptive name for the card.

/crm/v3/extensions/cards-dev/{appId}/{cardId}

Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	The ID of the app that owns the card. Specify the app ID from your developer account.
`Cardid`	The ID of the card to delete. Provide the unique identifier of the card you want to remove.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/extensions/cards-dev/{appId}/{cardId}

Returns the definition for a card with the given ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	The ID of the app that owns the card. Enter the app ID from your developer account.
`Cardid`	The ID of the card to retrieve. Provide the unique identifier of the card you want to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/extensions/cards-dev/{appId}

Returns a list of cards for a given app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	The ID of the app whose cards you want to list. Specify the app ID from your developer account.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/extensions/cards-dev/{appId}/{cardId}

Update a card definition with new details.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	The ID of the app that owns the card. Provide the app ID from your developer account.
`Cardid`	The ID of the card to update. Enter the unique identifier of the card you want to modify.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Title`	The new title for the card. Specify the updated display name.

/crm/v3/imports/{importId}/cancel

This allows a developer to cancel an active import.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Importid`	The ID of the import to cancel. Provide the unique identifier of the active import you want to stop.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/imports

Returns a paged list of active imports for this account.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`After`	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.
`Before`	A cursor that specifies the point before which to retrieve imports. Use the before value from a previous response to paginate backwards.
`Limit`	The maximum number of results to display per page.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/imports/{importId}

A complete summary of an import record, including any updates.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Importid`	The ID of the import to retrieve details for. Provide the unique identifier of the import you want to inspect.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/imports

Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Files`	A list of files containing the data to import
`Importrequest`	JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See the overview tab for more on the required format.

/crm/v3/exports/export/async

Begins exporting CRM data for the portal as specified in the request body

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Exportname`	A name for the export to help identify it. Enter a descriptive label.
`Exporttype`	The type of export, such as 'contacts' or 'companies'. Specify the object type you want to export.
`Format`	The file format for the export, for example 'csv' or 'xlsx'. Choose the desired output format.
`Language`	The language to use for export headers and formatting. Provide a language code like 'en'.
`Objectproperties`	The list of property names to include in the export. Provide an array of property names as strings.
`Objecttype`	The object type to export, such as 'contacts' or 'deals'. Specify which type of records to export.
`Associatedobjecttype`	An optional associated object type to include related data. Provide the object type that is associated with the primary export object.

/crm/v4/associations/{fromObjectType}/{toObjectType}/labels

Create a user defined association definition

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Label`	The display name for the forward association label.
`Name`	The internal name used to identify the label programmatically.
`Inverselabel`	The display name for the inverse (reverse) association label.

/crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId}

Deletes an association definition

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Associationtypeid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/labels

Returns all association types between two object types

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v4/associations/{fromObjectType}/{toObjectType}/labels

Update a user defined association definition

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	(Required)
`Toobjecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Associationtypeid`	The numeric ID of the association type to update.
`Label`	The new display name for the forward association label.
`Inverselabel`	The new display name for the inverse association label.

/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/delete

Remove a list of portal IDs from a feature flag for an app.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Portalids`	An array of portal IDs to be removed from the feature flag.

/crm/v3/objects/fees/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Objectid`	The ID of the fee object to be GDPR-deleted.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/objects/taxes/gdpr-delete

Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Objectid`	The ID of the tax object to be GDPR-deleted.
`Idproperty`	The name of the unique property to use for identifying contacts if not using internal IDs.

/crm/v3/lists

Create a new list with the provided object list definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	The name to assign to the new list.
`Objecttypeid`	The object type ID that the list will be based on.
`Processingtype`	The processing type for the list, such as MANUAL or SNAPSHOT.
`Listfolderid`	The ID of the folder where the list should be placed.

/crm/v3/lists/folders

Creates a folder with the given information.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The name of the new folder.
`Parentfolderid`	The ID of the parent folder under which to create this folder.

/crm/v3/lists/{listId}

Delete a list by ILS list ID. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to delete.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/folders/{folderId}

Deletes the folder with the given Id.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/memberships/join-order

Fetch the memberships of a list in order sorted by the time the records were added to the list.

The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order.

The after offset parameter will take precedence over the before offset in a case where both are provided.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`After`	The paging offset token for the page that comes after the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the before offset.
`Before`	The paging offset token for the page that comes before the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
`Limit`	The number of records to return in the response. The maximum limit is 250.
`Listid`	(Required) The ILS ID of the list.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}

Fetch a single list by ILS list ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includefilters`	A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}

Fetch a single list by list name and object type.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includefilters`	A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
`Objecttypeid`	The object type ID that the list belongs to.
`Listname`	The name of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists

Fetch multiple lists in a single request by ILS list ID. The response will include the definitions of all lists that exist for the listIds provided.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listids`	The ILS IDs of the lists to fetch.
`Includefilters`	A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships

For given record provide lists this record is member of.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttypeid`	(Required) Object type id of the record
`Recordid`	(Required) Id of the record
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}

This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folderid`	(Required)
`Newparentfolderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/folders/move-list

Given a list and a folder, the list will be moved to that folder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Listid`	The ID of the list to be moved to a new folder.
`Newfolderid`	The ID of the destination folder where the list should be placed.

/crm/v3/lists/folders/{folderId}/rename

Renames the given folderId with a new name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Newfoldername`	The new name to assign to the folder.
`Folderid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/restore

Restore a previously deleted list by ILS list ID. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/folders

Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folderid`	The Id of the folder to retrieve.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/idmapping

This API allows translation of legacy list id to list id. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Legacylistid`	The legacy list id from lists v1 API.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/idmapping

This API allows translation of a batch of legacy list id's to list id's. This allows for a maximum of 10,000 id's. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of objects containing legacy list IDs to be translated to modern IDs.

/crm/v3/lists/{listId}/update-list-filters

Update the filter branch definition of a DYNAMIC list. Once updated, the list memberships will be re-evaluated and updated to match the new definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Enrollobjectsinworkflows`	A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/update-list-name

Update the name of a list. The name must be globally unique relative to all other public lists in the portal.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listname`	The name to update the list to.
`Includefilters`	A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/search

Search lists by list name or page through all lists by providing an empty query value.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Additionalproperties`	Additional search properties to filter results.
`Offset`	The offset value for paginating through the search results.
`Query`	The search query string used to find matching lists.
`Count`	The number of results to return per page.
`Listids`	An array of list IDs to restrict the search to specific lists.
`Processingtypes`	An array of processing types to filter lists by their processing mode.

/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}

Add all of the records from a source list (specified by the sourceListId) to a destination list (specified by the listId). Records that are already members of the destination list will be ignored. The destination and source list IDs must be different. The destination and source lists must contain records of the same type (e.g. contacts, companies, etc.).

This endpoint only works for destination lists that have a processingType of MANUAL or SNAPSHOT. The source list can have any processingType.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Sourcelistid`	The ID of the source list whose records will be added to the destination list.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/memberships/add

Add the records provided to the list. Records that do not exist or that are already members of the list are ignored.

This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of objects containing the record IDs to add to the list.

/crm/v3/lists/{listId}/memberships/add-and-remove

Add and/or remove records that have already been created in the system to and/or from a list.

This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Recordidstoadd`	An array of record IDs to be added to the list.
`Recordidstoremove`	An array of record IDs to be removed from the list.

/crm/v3/lists/{listId}/memberships

Remove all of the records from a list. *Note: The list is not deleted.*

This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/memberships

Fetch the memberships of a list in order sorted by the recordId of the records in the list.

The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order.

The after offset parameter will take precedence over the before offset in a case where both are provided.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`After`	The paging offset token for the page that comes after the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the before offset.
`Before`	The paging offset token for the page that comes before the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
`Limit`	The number of records to return in the response. The maximum limit is 250.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/lists/{listId}/memberships/remove

Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored.

This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Listid`	The ID of the list to fetch.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of objects containing the record IDs to add to the list.

/crm/v3/owners

Retrieve a paginated list of all owners in the HubSpot CRM. Use this action to fetch owner records for use in other operations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Email`	Filter by email address (optional)
`After`	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.
`Limit`	The maximum number of results to display per page.
`Archived`	Whether to return only results that have been archived.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/owners/{ownerId}

Retrieve a specific owner record using its unique identifier. Use this to get details about a single owner.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Idproperty`	Specify the property type (e.g., 'id' or 'userId') to identify the owner when the ownerId parameter is ambiguous.
`Archived`	Whether to return only results that have been archived.
`Ownerid`	The unique identifier of the owner to retrieve, either the internal ID or the user ID depending on the idProperty value.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}/audit

Return a reverse chronological list of all mutations that have occurred on the pipeline identified by {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}/stages

Create a new stage associated with the pipeline identified by {pipelineId}. The entire stage object, including its unique ID, will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Displayorder`	The order in which this stage appears relative to other stages in the pipeline, typically as a number.
`Label`	The new display name for the forward association label.

/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Delete the pipeline stage identified by {stageId} associated with the pipeline identified by {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Stageid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Stageid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Displayorder`	The new display order position for the stage within the pipeline.
`Label`	The new display name for the forward association label.

/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Return the stage identified by {stageId} associated with the pipeline identified by {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Stageid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}/stages

Return all the stages associated with the pipeline identified by {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Perform a partial update of the pipeline stage identified by {stageId} associated with the pipeline identified by {pipelineId}. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Stageid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Archived`	Set to 'true' to archive the stage, removing it from active use.
`Displayorder`	The new display order position for the stage within the pipeline.
`Label`	The new display name for the forward association label.

/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit

Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by {stageId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Stageid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}

Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Displayorder`	The order in which this pipeline appears relative to other pipelines of the same object type.
`Label`	The new display name for the forward association label.

/crm/v3/pipelines/{objectType}/{pipelineId}

Delete the pipeline identified by {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Validatereferencesbeforedelete`	When set to 'true', the API checks for any references to this pipeline before deleting and returns an error if found.
`Validatedealstageusagesbeforedelete`	When set to 'true', the API checks for any deals or other records currently using stages in this pipeline before deletion.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}

Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Validatereferencesbeforedelete`	When set to 'true', the API checks for any references to this pipeline before applying the replacement and returns an error if found.
`Validatedealstageusagesbeforedelete`	When set to 'true', the API checks for any deals or other records currently using stages in this pipeline before replacing it.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Displayorder`	The new display order position for the pipeline relative to other pipelines of the same object type.
`Label`	The new display name for the forward association label.

/crm/v3/pipelines/{objectType}

Return all pipelines for the object type specified by {objectType}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}

Return a single pipeline object identified by its unique {pipelineId}.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/pipelines/{objectType}/{pipelineId}

Perform a partial update of the pipeline identified by {pipelineId}. The updated pipeline will be returned in the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Validatereferencesbeforedelete`	When set to 'true', the API checks for any references to this pipeline before applying the replacement and returns an error if found.
`Validatedealstageusagesbeforedelete`	When set to 'true', the API checks for any deals or other records currently using stages in this pipeline before replacing it.
`Objecttype`	(Required)
`Pipelineid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Archived`	Set to 'true' to archive the stage, removing it from active use.
`Displayorder`	The new display order position for the pipeline relative to other pipelines of the same object type.
`Label`	The new display name for the forward association label.

/feature-flags/v3/{appId}/flags/{flagName}/portals

Retrieve portals that have a given feature flag enabled. Use this to see which portals are using a specific feature flag.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Startportalid`	The ID of the portal to start from when paginating through results.
`Limit`	The maximum number of portal results to return per page.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/exports/export/async/tasks/{taskId}/status

Retrieve the current status of an asynchronous export task. Use this to check whether an export has completed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Taskid`	The ID of the export task whose status you want to check.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/imports/{importId}/errors

Retrieve error details for a specific import. Use this to diagnose why an import failed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`After`	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.
`Limit`	The maximum number of results to display per page.
`Importid`	The ID of the import to retrieve details for. Provide the unique identifier of the import you want to inspect.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/merge

Merge two fee objects of the same type into a single record. Use this to combine duplicate fee entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Objectidtomerge`	The ID of the fee object that will be merged into the primary object.
`Primaryobjectid`	The ID of the fee object that will remain after the merge.

/crm/v3/objects/{objectType}/merge

Merge two objects of the same object type into a single record. Use this to combine duplicate objects of any type.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Objectidtomerge`	The ID of the object that will be merged into the primary object.
`Primaryobjectid`	The ID of the object that will remain after the merge.

/crm/v3/objects/taxes/merge

Merge two tax objects of the same type into a single record. Use this to combine duplicate tax entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Objectidtomerge`	The ID of the tax object that will be merged into the primary object.
`Primaryobjectid`	The ID of the tax object that will remain after the merge.

/crm/v3/extensions/cards-dev/sample-response

Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/carts/search

Search for cart objects using a query. Use this to find carts matching specific criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/commerce_payments/search

Search for commerce payment objects using a query. Use this to find payments matching specific criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/companies/search

Search for company objects using a query. Use this to find companies matching specific criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/contacts/search

Search for contact objects using a query. Use this to find contacts matching specific criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/deals/search

Search for deal objects using a query. Use this to find deals matching specific criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/discounts/search

Search for discount records using a filter query. Returns a paginated list of discounts that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/feedback_submissions/search

Search for feedback submission records using a filter query. Returns a paginated list of feedback submissions that match the specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/fees/search

Search for fee records using a filter query. Returns a paginated list of fees that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/goal_targets/search

Search for goal target records using a filter query. Returns a paginated list of goal targets that match the specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/invoices/search

Search for invoice records using a filter query. Returns a paginated list of invoices that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/leads/search

Search for lead records using a filter query. Returns a paginated list of leads that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/line_items/search

Search for line item records using a filter query. Returns a paginated list of line items that match the specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/orders/search

Search for order records using a filter query. Returns a paginated list of orders that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/payments/search

Search for payment records using a filter query. Returns a paginated list of payments that match the specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/products/search

Search for product records using a filter query. Returns a paginated list of products that match the specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/quotes/search

Search for quote records using a filter query. Returns a paginated list of quotes that match the specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/subscriptions/search

Search for subscriptions using filters and criteria. Returns a list of matching subscription records.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/taxes/search

Search for taxes using filters and criteria. Returns a list of matching tax records.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/objects/tickets/search

Search for tickets using filters and criteria. Returns a list of matching ticket records.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Specify the Content-Type header for the batch update request. The expected value is 'application/json'.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/crm/v3/objects/{objectType}/search

Search for any CRM object type by specifying the object type in the path. Returns a list of matching records.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	The type of object to create, for example "contacts" or "companies".
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`After`	A pagination cursor to retrieve the next set of search results.
`Limit`	The maximum number of search results to return.
`Properties`	A list of property names to include in the response for each contact.
`Sorts`	An array of sort criteria to order the search results.
`Query`	The search query string used to find matching lists.

/crm/v3/associations/{fromObjectType}/{toObjectType}/types

List all the valid association types available between two object types

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fromobjecttype`	The type of the source object, such as 'contact' or 'company'.
`Toobjecttype`	The type of the target object for which to list associations.
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/upsert

Upsert portal overrides for a feature flag in batch. Creates or updates portal-level flag states for the given app and flag.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}

Permanently delete a specific feature flag by app ID and flag name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}

Retrieve details of a specific feature flag by app ID and flag name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}

Update the default state and optional override state for a feature flag. Use this to change flag behavior globally.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Defaultstate`	The new default state for the flag, either ENABLED or DISABLED.
`Overridestate`	The new override state for the flag, either ENABLED, DISABLED, or NO_OVERRIDE.

/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}

Delete a portal-level override for a specific feature flag. Removes the custom state for the given portal.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Portalid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}

Retrieve the portal-level flag state for a specific portal, app, and flag.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Portalid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}

Set or update the portal-level flag state for a specific portal, app, and flag.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Appid`	(Required)
`Flagname`	(Required)
`Portalid`	(Required)
`Accept`	Specifies the content type the client expects in the response, such as "application/json".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Flagstate`	The desired flag state for this portal, either ENABLED or DISABLED.

Basic (92)

Batch (78)

Cards (5)

Core (5)

Definitions (4)

Delete

Lists API (18)

Lists

Memberships (6)

Owners (2)

Pipeline Audits

Pipeline Stages (6)

Pipelines API

Pipelines (6)

Portals

Public_Exports

Public_Imports

Public_Object (3)

SampleResponse

Search (20)

Types

Upsert

{flagName} (3)

{portalId} (3)

Basic (92)

Batch (78)

Cards (5)

Core (5)

Definitions (4)

Delete

GDPR (2)

Lists API (18)

Lists

Memberships (6)

Owners (2)

Pipeline Audits

Pipeline Stages (6)

Pipelines API

Pipelines (6)

Portals

Public_Exports

Public_Imports

Public_Object (3)

SampleResponse

Search (20)

Types

Upsert

{flagName} (3)

{portalId} (3)