Version 1
Connector Overview: This page documents all 263 actions for the Hubspotcrmconnector v1.
Basic (92)
DELETE Archive
/crm/v3/objects/carts/{cartId}
Move an Object identified by {cartId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/commerce_payments/{commercePaymentId}
Move an Object identified by {commercePaymentId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/companies/{companyId}
Move an Object identified by {companyId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/contacts/{contactId}
Move an Object identified by {contactId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/{objectType}/{objectId}
Move an Object identified by {objectId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/deals/{dealId}
Move an Object identified by {dealId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/discounts/{discountId}
Move an Object identified by {discountId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}
Move an Object identified by {feedbackSubmissionId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/fees/{feeId}
Move an Object identified by {feeId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/leads/{leadsId}
Move an Object identified by {leadsId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/line_items/{lineItemId}
Move an Object identified by {lineItemId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/orders/{orderId}
Move an Object identified by {orderId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/products/{productId}
Move an Object identified by {productId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/quotes/{quoteId}
Move an Object identified by {quoteId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/taxes/{taxId}
Move an Object identified by {taxId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Archive
/crm/v3/objects/tickets/{ticketId}
Move an Object identified by {ticketId} to the recycling bin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Create
/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}
Set association labels between two records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Create Default
/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
Create the default (most generic) association type between two object types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create1
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create10
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create11
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create12
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create13
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create14
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create2
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create3
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create4
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create5
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create6
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create7
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create8
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create9
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete
/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}
deletes all associations between two records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List
/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}
List all associations of an object by object type. Limit 500 per call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
The maximum number of results to display per page. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List
/crm/v3/objects/carts
Read a page of carts. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List
/crm/v3/objects/{objectType}
Read a page of objects. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List1
/crm/v3/objects/commerce_payments
Read a page of commerce payments. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List10
/crm/v3/objects/leads
Read a page of leads. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List11
/crm/v3/objects/line_items
Read a page of line items. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List12
/crm/v3/objects/orders
Read a page of orders. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List13
/crm/v3/objects/payments
Read a page of payments. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List14
/crm/v3/objects/products
Read a page of products. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List15
/crm/v3/objects/quotes
Read a page of quotes. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List16
/crm/v3/objects/taxes
Read a page of taxes. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List17
/crm/v3/objects/tickets
Read a page of tickets. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List18
/crm/v3/objects/invoices
Read a page of invoices. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List2
/crm/v3/objects/subscriptions
Read a page of subscriptions. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List3
/crm/v3/objects/companies
Read a page of companies. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List4
/crm/v3/objects/contacts
Read a page of contacts. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List5
/crm/v3/objects/deals
Read a page of deals. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List6
/crm/v3/objects/discounts
Read a page of discounts. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List7
/crm/v3/objects/feedback_submissions
Read a page of feedback submissions. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List8
/crm/v3/objects/fees
Read a page of fees. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET List9
/crm/v3/objects/goal_targets
Read a page of goal targets. Control what is returned via the properties query param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type. |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Whether to return only results that have been archived. |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of a property whose values are unique for this object type |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Batch (78)
POST Archive a batch of associations
/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive
Remove the associations between all pairs of objects identified in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
POST Archive a batch of carts by ID
/crm/v3/objects/carts/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of commerce payments by ID
/crm/v3/objects/commerce_payments/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of companies by ID
/crm/v3/objects/companies/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of contacts by ID
/crm/v3/objects/contacts/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of deals by ID
/crm/v3/objects/deals/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of discounts by ID
/crm/v3/objects/discounts/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of feedback submissions by ID
/crm/v3/objects/feedback_submissions/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of fees by ID
/crm/v3/objects/fees/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of leads by ID
/crm/v3/objects/leads/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of line items by ID
/crm/v3/objects/line_items/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of objects by ID
/crm/v3/objects/{objectType}/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of orders by ID
/crm/v3/objects/orders/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of products by ID
/crm/v3/objects/products/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of quotes by ID
/crm/v3/objects/quotes/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of taxes by ID
/crm/v3/objects/taxes/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Archive a batch of tickets by ID
/crm/v3/objects/tickets/batch/archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create
Batch create associations for objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Default Associations
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default
Create the default (most generic) association type between two object types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of associations
/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create
Associate all pairs of objects identified in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
POST Create a batch of carts
/crm/v3/objects/carts/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of commerce payments
/crm/v3/objects/commerce_payments/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of companies
/crm/v3/objects/companies/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of contacts
/crm/v3/objects/contacts/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of deals
/crm/v3/objects/deals/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of discounts
/crm/v3/objects/discounts/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of feedback submissions
/crm/v3/objects/feedback_submissions/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of fees
/crm/v3/objects/fees/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of leads
/crm/v3/objects/leads/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of line items
/crm/v3/objects/line_items/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of objects
/crm/v3/objects/{objectType}/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of orders
/crm/v3/objects/orders/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of products
/crm/v3/objects/products/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of quotes
/crm/v3/objects/quotes/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of taxes
/crm/v3/objects/taxes/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a batch of tickets
/crm/v3/objects/tickets/batch/create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
/crm/v3/objects/deals/splits/batch/upsert
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive
Batch delete associations for objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Specific Labels
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of associations
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
POST Read a batch of carts by internal ID, or unique property values
/crm/v3/objects/carts/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of commerce payments by internal ID, or unique property values
/crm/v3/objects/commerce_payments/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of companies by internal ID, or unique property values
/crm/v3/objects/companies/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of contacts by internal ID, or unique property values
/crm/v3/objects/contacts/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of deal split objects by their associated deal object internal ID
/crm/v3/objects/deals/splits/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of deals by internal ID, or unique property values
/crm/v3/objects/deals/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of discounts by internal ID, or unique property values
/crm/v3/objects/discounts/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of feedback submissions by internal ID, or unique property values
/crm/v3/objects/feedback_submissions/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of fees by internal ID, or unique property values
/crm/v3/objects/fees/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of goal targets by internal ID, or unique property values
/crm/v3/objects/goal_targets/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of invoices by internal ID, or unique property values
/crm/v3/objects/invoices/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of leads by internal ID, or unique property values
/crm/v3/objects/leads/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of line items by internal ID, or unique property values
/crm/v3/objects/line_items/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of objects by internal ID, or unique property values
/crm/v3/objects/{objectType}/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of orders by internal ID, or unique property values
/crm/v3/objects/orders/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of payments by internal ID, or unique property values
/crm/v3/objects/payments/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of products by internal ID, or unique property values
/crm/v3/objects/products/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of quotes by internal ID, or unique property values
/crm/v3/objects/quotes/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of subscriptions by internal ID, or unique property values
/crm/v3/objects/subscriptions/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of taxes by internal ID, or unique property values
/crm/v3/objects/taxes/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Read a batch of tickets by internal ID, or unique property values
/crm/v3/objects/tickets/batch/read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of carts
/crm/v3/objects/carts/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of commerce payments
/crm/v3/objects/commerce_payments/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of companies by internal ID, or unique property values
/crm/v3/objects/companies/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of contacts by internal ID, or unique property values
/crm/v3/objects/contacts/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of deals by internal ID, or unique property values
/crm/v3/objects/deals/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of discounts
/crm/v3/objects/discounts/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of feedback submissions by internal ID, or unique property values
/crm/v3/objects/feedback_submissions/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of fees
/crm/v3/objects/fees/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of leads
/crm/v3/objects/leads/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of line items by internal ID, or unique property values
/crm/v3/objects/line_items/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of objects
/crm/v3/objects/{objectType}/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of orders
/crm/v3/objects/orders/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of products by internal ID, or unique property values
/crm/v3/objects/products/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of quotes by internal ID, or unique property values
/crm/v3/objects/quotes/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of taxes
/crm/v3/objects/taxes/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a batch of tickets by internal ID, or unique property values
/crm/v3/objects/tickets/batch/update
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Cards (5)
POST Create a new card
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete a 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a card.
/crm/v3/extensions/cards-dev/{appId}/{cardId}
Returns the definition for a card with the given ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all cards
/crm/v3/extensions/cards-dev/{appId}
Returns a list of cards for a given app.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update a card
/crm/v3/extensions/cards-dev/{appId}/{cardId}
Update a card definition with new details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Core (5)
POST Cancel an active import
/crm/v3/imports/{importId}/cancel
This allows a developer to cancel an active import.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get active imports
/crm/v3/imports
Returns a paged list of active imports for this account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
The maximum number of results to display per page. |
|
|
N/A |
|
|
N/A |
GET Get the information on any import
/crm/v3/imports/{importId}
A complete summary of an import record, including any updates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Start a new import
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A list of files containing the data to import |
|
|
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. |
POST Start an export
/crm/v3/exports/export/async
Begins exporting CRM data for the portal as specified in the request body
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Definitions (4)
POST Create
/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
Create a user defined association definition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete
/crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId}
Deletes an association definition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Read
/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
Returns all association types between two object types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT Update
/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
Update a user defined association definition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Delete
POST post-/feature-flags/v3/{app Id}/flags/{flag Name}/portals/batch/delete
/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/delete
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GDPR (2)
POST GDPR DELETE
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST GDPR DELETE1
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Lists API (18)
POST Create List
/crm/v3/lists
Create a new list with the provided object list definition.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Creates a folder
/crm/v3/lists/folders
Creates a folder with the given information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
DELETE Delete a List
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Deletes a folder
/crm/v3/lists/folders/{folderId}
Deletes the folder with the given Id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Fetch List Memberships Ordered by Added to List Date
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
The number of records to return in the response. The maximum limit is 250. |
|
|
(Required) The ILS ID of the list. |
|
|
N/A |
|
|
N/A |
GET Fetch List by ID
/crm/v3/lists/{listId}
Fetch a single list by ILS list ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Fetch List by Name
/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}
Fetch a single list by list name and object type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Fetch Multiple Lists
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ILS IDs of the lists to fetch. |
|
|
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. |
|
|
N/A |
|
|
N/A |
GET Get lists record is member of
/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships
For given record provide lists this record is member of.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Object type id of the record |
|
|
(Required) Id of the record |
|
|
N/A |
|
|
N/A |
PUT Moves a folder
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT Moves a list to a given folder
/crm/v3/lists/folders/move-list
Given a list and a folder, the list will be moved to that folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Rename a folder
/crm/v3/lists/folders/{folderId}/rename
Renames the given folderId with a new name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT Restore a List
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieves a folder.
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Id of the folder to retrieve. |
|
|
N/A |
|
|
N/A |
GET Translate Legacy List Id to Modern List Id
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The legacy list id from lists v1 API. |
|
|
N/A |
|
|
N/A |
POST Translate Legacy List Id to Modern List Id in Batch
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update List Filter Definition
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update List Name
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name to update the list to. |
|
|
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. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Lists
POST Search Lists
/crm/v3/lists/search
Search lists by list name or page through all lists by providing an empty query value.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Memberships (6)
PUT Add All Records from a Source List to a Destination List
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Add Records to a List
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Add and/or Remove Records from a 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
DELETE Delete All Records from a 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Fetch List Memberships Ordered by ID
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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. |
|
|
The number of records to return in the response. The maximum limit is 250. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Remove Records from a List
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Owners (2)
GET Get a page of owners
/crm/v3/owners
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter by email address (optional) |
|
|
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. |
|
|
The maximum number of results to display per page. |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
GET Read an owner by given `id` or `userId`
/crm/v3/owners/{ownerId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to return only results that have been archived. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Pipeline Audits
GET Return an audit of all changes to the pipeline
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Pipeline Stages (6)
POST Create a pipeline stage
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
DELETE Delete a pipeline stage
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT Replace a pipeline stage
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
GET Return a pipeline stage by ID
/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
Return the stage identified by {stageId} associated with the pipeline identified by {pipelineId}.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Return all stages of a pipeline
/crm/v3/pipelines/{objectType}/{pipelineId}/stages
Return all the stages associated with the pipeline identified by {pipelineId}.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update a pipeline stage
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Pipelines API
GET Return an audit of all changes to the pipeline stage
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Pipelines (6)
POST Create a pipeline
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
DELETE Delete a pipeline
/crm/v3/pipelines/{objectType}/{pipelineId}
Delete the pipeline identified by {pipelineId}.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT Replace a pipeline
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
GET Retrieve all pipelines
/crm/v3/pipelines/{objectType}
Return all pipelines for the object type specified by {objectType}.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET Return a pipeline by ID
/crm/v3/pipelines/{objectType}/{pipelineId}
Return a single pipeline object identified by its unique {pipelineId}.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PATCH Update a pipeline
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Portals
GET get-/feature-flags/v3/{app Id}/flags/{flag Name}/portals
/feature-flags/v3/{appId}/flags/{flagName}/portals
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Public_Exports
GET get-/crm/v3/exports/export/async/tasks/{task Id}/status
/crm/v3/exports/export/async/tasks/{taskId}/status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Public_Imports
GET get-/crm/v3/imports/{import Id}/errors get Errors
/crm/v3/imports/{importId}/errors
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
The maximum number of results to display per page. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Public_Object (3)
POST Merge two fees with same type
/crm/v3/objects/fees/merge
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Merge two objects with same type
/crm/v3/objects/{objectType}/merge
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Merge two taxes with same type
/crm/v3/objects/taxes/merge
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
SampleResponse
GET Get sample card detail response
/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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Search (20)
POST post-/crm/v3/objects/carts/search
/crm/v3/objects/carts/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/commerce payments/search
/crm/v3/objects/commerce_payments/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/companies/search do Search
/crm/v3/objects/companies/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/contacts/search do Search
/crm/v3/objects/contacts/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/deals/search do Search
/crm/v3/objects/deals/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/discounts/search
/crm/v3/objects/discounts/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/feedback submissions/search do Search
/crm/v3/objects/feedback_submissions/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/fees/search
/crm/v3/objects/fees/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/goal targets/search do Search
/crm/v3/objects/goal_targets/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/invoices/search
/crm/v3/objects/invoices/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/leads/search
/crm/v3/objects/leads/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/line items/search do Search
/crm/v3/objects/line_items/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/orders/search
/crm/v3/objects/orders/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/payments/search
/crm/v3/objects/payments/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/products/search do Search
/crm/v3/objects/products/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/quotes/search do Search
/crm/v3/objects/quotes/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/subscriptions/search
/crm/v3/objects/subscriptions/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/taxes/search
/crm/v3/objects/taxes/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/tickets/search do Search
/crm/v3/objects/tickets/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST post-/crm/v3/objects/{object Type}/search
/crm/v3/objects/{objectType}/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Types
GET List association types
/crm/v3/associations/{fromObjectType}/{toObjectType}/types
List all the valid association types available between two object types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Upsert
POST post-/feature-flags/v3/{app Id}/flags/{flag Name}/portals/batch/upsert
/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/upsert
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
{flagName} (3)
DELETE delete-/feature-flags/v3/{app Id}/flags/{flag Name}
/feature-flags/v3/{appId}/flags/{flagName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET get-/feature-flags/v3/{app Id}/flags/{flag Name}
/feature-flags/v3/{appId}/flags/{flagName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT put-/feature-flags/v3/{app Id}/flags/{flag Name}
/feature-flags/v3/{appId}/flags/{flagName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
{portalId} (3)
DELETE delete-/feature-flags/v3/{app Id}/flags/{flag Name}/portals/{portal Id}
/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
GET get-/feature-flags/v3/{app Id}/flags/{flag Name}/portals/{portal Id}
/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
PUT put-/feature-flags/v3/{app Id}/flags/{flag Name}/portals/{portal Id}
/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |