HubSpot CRM V2 (Independent Publisher) (Preview)
With the easy-to-use HubSpot CRM, you'll never have to manually update reports or wonder how your team is tracking toward quotas. Get a real-time view of your entire sales pipeline on a visual dashboard. HubSpot CRM will automatically organize, enrich, and track each contact in a tidy timeline.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.hubspot.com/products/crm |
| Privacy policy | hhttps://legal.hubspot.com/privacy-policy |
| Categories | Sales and CRM |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Access Token (in the form 'Bearer ${YOUR_TOKEN}') | securestring | The Access Token (in the form 'Bearer ${YOUR_TOKEN}') for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add all records from a source list to a destination list |
Add all of the records from a source list (specified by the |
| Add and or remove records from a list |
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 |
| Add records to a list |
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 |
| Archive a batch of companies by ID |
Archive a batch of companies by identifier. |
| Archive a batch of contacts by ID |
Archive a batch of contacts by identifier. |
| Archive a batch of deals by ID |
Archive a batch of deals by identifier. |
| Archive a batch of discounts by ID |
Archive a batch of discounts by identifier. |
| Archive a batch of feedback submissions by ID |
Archive a batch of feedback submissions by identifier. |
| Archive a batch of fees by ID |
Archive a batch of fees by identifier. |
| Archive a batch of goal targets by ID |
Archive a batch of goal targets by identifier. |
| Archive a batch of line items by ID |
Archive a batch of line items by identifier. |
| Archive a batch of objects by ID |
Archive a batch of objects by identifier. |
| Archive a batch of products by ID |
Archive a batch of products by identifier. |
| Archive a batch of quotes by ID |
Archive a batch of quotes by identifier. |
| Archive a batch of taxes by ID |
Archive a batch of taxes by identifier. |
| Archive a batch of tickets by ID |
Archive a batch of tickets by identifier. |
| Archive a company by ID |
Move an object identified by companyId to the recycling bin. |
| Archive a contact by ID |
Move an object identified by contactId to the recycling bin. |
| Archive a deal by ID |
Move an object identified by dealId to the recycling bin. |
| Archive a discount |
Move an object identified by discountId to the recycling bin. |
| Archive a fee by ID |
Move an object identified by feeId to the recycling bin. |
| Archive a feedback submission |
Move an object identified by feedbackSubmissionId to the recycling bin. |
| Archive a goal target |
Move an object identified by goalTargetId to the recycling bin. |
| Archive a line item |
Move an object identified by lineItemId to the recycling bin. |
| Archive a product |
Move an object identified by productId to the recycling bin. |
| Archive a quote by ID |
Move an object identified by quoteId to the recycling bin. |
| Archive a tax |
Move an object identified by taxId to the recycling bin. |
| Archive a ticket |
Move an object identified by ticketId to the recycling bin. |
| Archive an object |
Move an object identified by objectId to the recycling bin. |
| Cancel an active import |
This allows a developer to cancel an active import. |
| Create a batch of companies |
Create a batch of companies. |
| Create a batch of contacts |
Create a batch of contacts. |
| Create a batch of deals |
Create a batch of deals. |
| Create a batch of discounts |
Create a batch of discounts. |
| Create a batch of feedback submissions |
Create a batch of feedback submissions. |
| Create a batch of fees |
Create a batch of fees. |
| Create a batch of goal targets |
Create a batch of goal targets. |
| Create a batch of line items |
Create a batch of line items. |
| Create a batch of objects |
Create a batch of objects. |
| Create a batch of products |
Create a batch of products. |
| Create a batch of quotes |
Create a batch of quotes. |
| Create a batch of taxes |
Create a batch of taxes. |
| Create a batch of tickets |
Create a batch of tickets. |
| Create a company |
Create a company with the given properties and return a copy of the object, including the identifier. |
| Create a contact |
Create a contact with the given properties and return a copy of the object, including the identifier. |
| Create a deal |
Create a deal with the given properties and return a copy of the object, including the identifier. |
| Create a discount |
Create a discount with the given properties and return a copy of the object, including the identifier. |
| Create a fee |
Create a fee with the given properties and return a copy of the object, including the identifier. |
| Create a feedback submission |
Create a feedback submission with the given properties and return a copy of the object, including the identifier. |
| Create a goal target |
Create a goal target with the given properties and return a copy of the object, including the identifier. |
| Create a line item |
Create a line item with the given properties and return a copy of the object, including the identifier. |
| Create a new card |
Defines a new card that will become active on an account when this app is installed. |
| Create a product |
Create a product with the given properties and return a copy of the object, including the identifier. |
| Create a tax |
Create a tax with the given properties and return a copy of the object, including the identifier. |
| Create a ticket |
Create a ticket with the given properties and return a copy of the object, including the identifier. |
| Create an object |
Create a CRM object with the given properties and return a copy of the object, including the identifier. |
| Create association labels |
Set association labels between two records. |
| Create batch associations |
Batch create associations for objects. |
| Create default association |
Create the default (most generic) association type between two object types. |
| Create default associations |
Create the default (most generic) association type between two object types. |
| Create quote |
Create a quote with the given properties and return a copy of the object, including the identifier. |
| Delete a card |
Permanently deletes a card definition with the given identifier. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone. |
| Delete a company to follow GDPR |
Permanently delete a company and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a contact to follow GDPR |
Permanently delete a contact and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a deal to follow GDPR |
Permanently delete a deal and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a discount to follow GDPR |
Permanently delete a discount and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a fee to follow GDPR |
Permanently delete a fee and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a feedback submission to follow GDPR |
Permanently delete a feedback submission and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a goal target to follow GDPR |
Permanently delete a goal target and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a line item to follow GDPR |
Permanently delete a line item and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a product to follow GDPR |
Permanently delete a product and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a quote to follow GDPR |
Permanently delete a quote and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a tax to follow GDPR |
Permanently delete a tax and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete a ticket to follow GDPR |
Permanently delete a ticket and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete all records from a list |
Remove all of the records from a list. Note: The list is not deleted. This endpoint only works for lists that have a |
| Delete an object type to follow GDPR |
Permanently delete an object type and all associated content to follow GDPR. Use optional property 'ID Property' 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. |
| Delete associations |
Deletes all associations between two records. |
| Delete batch associations |
Batch delete associations for objects. |
| Delete specific association labels |
Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects. |
| Fetch list memberships |
Fetch the memberships of a list in order sorted by the |
| Get a batch of contacts by ID |
Retrieve a batch of contacts by internal identifier, or unique property values. |
| Get a batch of deals by ID |
Retrieve a batch of deals by internal identifier, or unique property values. |
| Get a batch of discounts by ID |
Retrieve a batch of discounts by internal identifier, or unique property values. |
| Get a batch of feedback submissions by ID |
Retrieve a batch of feedback submissions by internal identifier, or unique property values. |
| Get a batch of fees by ID |
Retrieve a batch of fees by internal identifier, or unique property values. |
| Get a batch of goal targets by ID |
Retrieve a batch of goal targets by internal identifier, or unique property values. |
| Get a batch of line items by ID |
Retrieve a batch of line items by internal identifier, or unique property values. |
| Get a batch of objects by ID |
Retrieve a batch of objects by internal identifier, or unique property values. |
| Get a batch of products by ID |
Retrieve a batch of products by internal identifier, or unique property values. |
| Get a batch of quotes by ID |
Retrieve a batch of quotes by internal identifier, or unique property values. |
| Get a batch of taxes by ID |
Retrieve a batch of taxes by internal identifier, or unique property values. |
| Get a batch of tickets by ID |
Retrieve a batch of tickets by internal identifier, or unique property values. |
| Get a card |
Returns the definition for a card with the given identifier. |
| Get a company by ID |
Retrieve an object identified by companyidentifier. companyId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a contact by ID |
Retrieve an object identified by contactidentifier. contactId refers to the internal object identifier. Control what is returned via the properties query parameter. |
| Get a deal |
Retrieve an object identified by dealidentifier. dealId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a discount |
Retrieve an object identified by discountidentifier. discountId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a fee by ID |
Retrieve an object identified by feeidentifier. feeId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a feedback submission |
Retrieve an object identified by feedbackSubmissionidentifier. feedbackSubmissionId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a goal target by ID |
Retrieve an object identified by goalTargetidentifier. goalTargetId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a product |
Retrieve an object identified by productidentifier. productId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a quote by ID |
Retrieve an object identified by quoteidentifier. quoteId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a tax by ID |
Retrieve an object identified by taxidentifier. taxId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get a ticket |
Retrieve an object identified by ticketidentifier. ticketId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get active imports |
Returns a paged list of active imports for this account. |
| Get all cards |
Returns a list of cards for a given app. |
| Get an object by ID |
Retrieve an object identified by objectidentifier. objectId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get an owner by ID |
Retrieve an owner by given identifier or useridentifier. |
| Get companies |
Retrieve a page of companies. Control what is returned via the properties query parameter. |
| Get companies by ID |
Retrieve a batch of companies by internal identifier, or unique property values. |
| Get contacts |
Retrieve a page of contacts. Control what is returned via the properties query parameter. |
| Get deals |
Retrieve a page of deals. Control what is returned via the properties query parameter. |
| Get fees |
Retrieve a page of fees. Control what is returned via the properties query parameter. |
| Get goal targets |
Retrieve a page of goal targets. Control what is returned via the properties query parameter. |
| Get import errors |
Retrieve a list of errors for an import. |
| Get line item |
Retrieve an object identified by lineItemidentifier. lineItemId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter. |
| Get line items |
Retrieve a page of line items. Control what is returned via the properties query parameter. |
| Get objects |
Retrieve a page of objects. Control what is returned via the properties query parameter. |
| Get owners |
Retrieve a list of owners. |
| Get products |
Retrieve a page of products. Control what is returned via the properties query parameter. |
| Get sample card detail 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. |
| Get task ID status |
Retrieve the status for a task identifier. |
| Get taxes |
Retrieve a page of taxes. Control what is returned via the properties query parameter. |
| Get the information on any import |
A complete summary of an import record, including any updates. |
| Get tickets |
Retrieve a page of tickets. Control what is returned via the properties query parameter. |
| List association types |
List all the valid association types available between two object types. |
| List associations for an object |
List all associations of an object by object type. Limit 500 per call. |
| List discounts |
Retrieve a page of discounts. Control what is returned via the properties query parameter. |
| List feedback submissions |
Retrieve a page of feedback submissions. Control what is returned via the properties query parameter. |
| List quotes |
Retrieve a page of quotes. Control what is returned via the properties query parameter. |
| Merge two companies |
Merge two companies with same type. |
| Merge two contact |
Merge two contacts with same type. |
| Merge two deals |
Merge two deals with same type. |
| Merge two discounts |
Merge two discounts with same type. |
| Merge two feedback submissions |
Merge two feedback submissions with same type. |
| Merge two fees |
Merge two fees with same type. |
| Merge two goal targets |
Merge two goal targets with same type. |
| Merge two line items |
Merge two line items with same type. |
| Merge two objects |
Merge two objects with same type. |
| Merge two products |
Merge two products with same type. |
| Merge two quotes |
Merge two quotes with same type. |
| Merge two taxes |
Merge two taxes with same type. |
| Merge two tickets |
Merge two tickets with same type. |
| Read batch associations |
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 objectidentifier. The 'link' field is deprecated and should be ignored. |
| Remove records from a list |
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 |
| Search by object type |
Retrieve a list of objects by object type. |
| Search companies |
Retrieve a list of companies. |
| Search deals |
Retrieve a list of deals. |
| Search discounts |
Retrieve a list of discounts. |
| Search feedback submissions |
Retrieve a list of feedback submissions. |
| Search for contacts |
Retrieve a list of contacts. |
| Search for fees |
Retrieve a list of fees. |
| Search goal targets |
Retrieve a list of goal targets. |
| Search line items |
Retrieve a list of line items. |
| Search lists |
Search lists by list name or page through all lists by providing an empty |
| Search products |
Retrieve a list of products. |
| Search quotes |
Retrieve a list of quotes. |
| Search taxes |
Retrieve a list of taxes. |
| Search tickets |
Retrieve a list of tickets. |
| Start a new import |
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. |
| Start an export |
Begins exporting CRM data for the portal as specified in the request body. |
| Update a batch of companies |
Update a batch of companies. |
| Update a batch of contacts |
Update a batch of contacts. |
| Update a batch of deals |
Update a batch of deals. |
| Update a batch of discounts |
Update a batch of discounts. |
| Update a batch of feedback submissions |
Update a batch of feedback submissions. |
| Update a batch of fees |
Update a batch of fees. |
| Update a batch of goal targets |
Update a batch of goal targets. |
| Update a batch of line items |
Update a batch of line items. |
| Update a batch of objects |
Update a batch of objects. |
| Update a batch of products |
Update a batch of products. |
| Update a batch of quotes |
Update a batch of quotes. |
| Update a batch of taxes |
Update a batch of taxes. |
| Update a batch of tickets |
Update a batch of tickets. |
| Update a card |
Update a card definition with new details. |
| Update a company by ID |
Perform a partial update of an object identified by companyidentifier. companyId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a contact by ID |
Perform a partial update of an object identified by contactidentifier. contactId refers to the internal object identifier. 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. |
| Update a deal |
Perform a partial update of an object identified by dealidentifier. dealId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a discount |
Perform a partial update of an object identified by discountidentifier. discountId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a fee by ID |
Perform a partial update of an object identified by feeidentifier. feeId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a feedback submission |
Perform a partial update of an object identified by feedbackSubmissionidentifier. feedbackSubmissionId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a goal target |
Perform a partial update of an object identified by goalTargetidentifier. goalTargetId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a line item |
Perform a partial update of an object identified by lineItemidentifier. lineItemId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a product |
Perform a partial update of an object identified by productidentifier. productId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a quote |
Perform a partial update of an object identified by quoteidentifier. quoteId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a tax |
Perform a partial update of an object identified by taxidentifier. taxId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update a ticket |
Perform a partial update of an object identified by ticketidentifier. ticketId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
| Update an object |
Perform a partial update of an object identified by objectidentifier. objectId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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. |
Add all records from a source list to a destination list
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
listId | True | string |
The list identifier. |
|
Source List ID
|
sourceListId | True | string |
The source list identifier. |
Returns
- response
- string
Add and or remove records from a list
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
listId | True | string |
The list identifier. |
|
Record IDs To Add
|
recordIdsToAdd | array of string |
The record identifiers to add. |
|
|
Record IDs To Remove
|
recordIdsToRemove | array of string |
The record identifiers to remove. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Record IDs Missing
|
recordIdsMissing | array of string |
The record identifiers missing. |
|
Record IDs Removed
|
recordIdsRemoved | array of string |
The record identifiers removed. |
|
Record IDs Added
|
recordsIdsAdded | array of string |
The record identifiers added. |
Add records to a list
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
listId | True | string |
The list identifier. |
|
body
|
body | True | array of string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Record IDs Missing
|
recordIdsMissing | array of string |
The record identifiers missing. |
|
Record IDs Removed
|
recordIdsRemoved | array of string |
The record identifiers removed. |
|
Record IDs Added
|
recordsIdsAdded | array of string |
The record identifiers added. |
Archive a batch of companies by ID
Archive a batch of companies by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of contacts by ID
Archive a batch of contacts by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of deals by ID
Archive a batch of deals by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of discounts by ID
Archive a batch of discounts by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of feedback submissions by ID
Archive a batch of feedback submissions by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of fees by ID
Archive a batch of fees by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of goal targets by ID
Archive a batch of goal targets by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of line items by ID
Archive a batch of line items by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of objects by ID
Archive a batch of objects by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of products by ID
Archive a batch of products by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of quotes by ID
Archive a batch of quotes by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of taxes by ID
Archive a batch of taxes by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a batch of tickets by ID
Archive a batch of tickets by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Archive a company by ID
Move an object identified by companyId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Company ID
|
companyId | True | string |
The company identifier. |
Returns
- response
- string
Archive a contact by ID
Move an object identified by contactId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact ID
|
contactId | True | string |
The contact identifier. |
Returns
- response
- string
Archive a deal by ID
Move an object identified by dealId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Deal ID
|
dealId | True | string |
The deal identifier. |
Returns
- response
- string
Archive a discount
Move an object identified by discountId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Discount ID
|
discountId | True | string |
The discount identifier. |
Returns
- response
- string
Archive a fee by ID
Move an object identified by feeId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fee ID
|
feeId | True | string |
The fee identifier. |
Returns
- response
- string
Archive a feedback submission
Move an object identified by feedbackSubmissionId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Feedback Submission ID
|
feedbackSubmissionId | True | string |
The feedback submission identifier. |
Returns
- response
- string
Archive a goal target
Move an object identified by goalTargetId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Goal Target ID
|
goalTargetId | True | string |
The goal target identifier. |
Returns
- response
- string
Archive a line item
Move an object identified by lineItemId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Line Item ID
|
lineItemId | True | string |
The line item identifier. |
Returns
- response
- string
Archive a product
Move an object identified by productId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Product ID
|
productId | True | string |
The product identifier. |
Returns
- response
- string
Archive a quote by ID
Move an object identified by quoteId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Quote ID
|
quoteId | True | string |
The quote identifier. |
Returns
- response
- string
Archive a tax
Move an object identified by taxId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Tax ID
|
taxId | True | string |
The tax identifier. |
Returns
- response
- string
Archive a ticket
Move an object identified by ticketId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Ticket ID
|
ticketId | True | string |
The ticket identifier. |
Returns
- response
- string
Archive an object
Move an object identified by objectId to the recycling bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
Returns
- response
- string
Cancel an active import
This allows a developer to cancel an active import.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Import ID
|
importId | True | string |
The import identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of companies
Create a batch of companies.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of contacts
Create a batch of contacts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of deals
Create a batch of deals.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of discounts
Create a batch of discounts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of feedback submissions
Create a batch of feedback submissions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of fees
Create a batch of fees.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of goal targets
Create a batch of goal targets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of line items
Create a batch of line items.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of objects
Create a batch of objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of products
Create a batch of products.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of quotes
Create a batch of quotes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of taxes
Create a batch of taxes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a batch of tickets
Create a batch of tickets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create a company
Create a company with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a contact
Create a contact with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a deal
Create a deal with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a discount
Create a discount with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
|
|
nostrudcf
|
nostrudcf | string |
nostrudcf. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a fee
Create a fee with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a feedback submission
Create a feedback submission with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a goal target
Create a goal target with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a line item
Create a line item with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a new card
Defines a new card that will become active on an account when this app is installed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app identifier. |
|
Base URLs
|
baseUrls | array of string |
The base URL addresses. |
|
|
Data Type
|
dataType | string |
The data type. |
|
|
Label
|
label | string |
The label. |
|
|
Name
|
name | string |
The name. |
|
|
Label
|
label | string |
The label. |
|
|
Name
|
name | string |
The name. |
|
|
Type
|
type | string |
The type. |
|
|
Name
|
name | string |
The name. |
|
|
Properties To Send
|
propertiesToSend | array of string |
The properties to send. |
|
|
Target URL
|
targetUrl | string |
The target URL address. |
|
|
Card Type
|
cardType | string |
The card type. |
|
|
Serverless Function
|
serverlessFunction | string |
The serverless function. |
|
|
Title
|
title | string |
The title. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
The base URL addresses. |
|
Audit History
|
auditHistory | array of object | |
|
Action Type
|
auditHistory.actionType | string |
The action type. |
|
Application ID
|
auditHistory.applicationId | string |
The application identifier. |
|
Authorization Source
|
auditHistory.authSource | string |
The authorization source. |
|
Changed At
|
auditHistory.changedAt | string |
When changed at. |
|
Initiating User ID
|
auditHistory.initiatingUserId | string |
The initiating user identifier. |
|
Object Type ID
|
auditHistory.objectTypeId | string |
The object type identifier. |
|
Properties
|
display.properties | array of object | |
|
Data Type
|
display.properties.dataType | string |
The data type. |
|
Label
|
display.properties.label | string |
The label. |
|
Name
|
display.properties.name | string |
The name. |
|
Options
|
display.properties.options | array of object | |
|
Label
|
display.properties.options.label | string |
The label. |
|
Name
|
display.properties.options.name | string |
The name. |
|
Type
|
display.properties.options.type | string |
The type. |
|
Object Types
|
fetch.objectTypes | array of object | |
|
Name
|
fetch.objectTypes.name | string |
The name. |
|
Properties To Send
|
fetch.objectTypes.propertiesToSend | array of string |
The properties to send. |
|
Target URL
|
fetch.targetUrl | string |
The target URL address. |
|
ID
|
id | string |
The identifier. |
|
Title
|
title | string |
The title. |
|
Created At
|
createdAt | string |
When created at. |
|
Updated At
|
updatedAt | string |
When updated at. |
Create a product
Create a product with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a tax
Create a tax with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create a ticket
Create a ticket with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create an object
Create a CRM object with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Create association labels
Set association labels between two records.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
To Object ID
|
toObjectId | True | string |
The To object identifier. |
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
From Object ID
|
fromObjectId | string |
The From object identifier. |
|
From Object Type ID
|
fromObjectTypeId | string |
The From object type identifier. |
|
Labels
|
labels | array of string |
The labels. |
|
To Object ID
|
toObjectId | string |
The To object identifier. |
|
To Object Type ID
|
toObjectTypeId | string |
The To object type identifier. |
Create batch associations
Batch create associations for objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
ID
|
id | string |
The identifier. |
|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
From Object ID
|
results.fromObjectId | string |
The From object identfiier. |
|
From Object Type ID
|
results.fromObjectTypeId | string |
The From object type identifier. |
|
Labels
|
results.labels | array of string |
The labels. |
|
To Object ID
|
results.toObjectId | string |
The To object identifier. |
|
To Object Type ID
|
results.toObjectTypeId | string |
The To object type identifier. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Create default association
Create the default (most generic) association type between two object types.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
From Object ID
|
fromObjectId | True | string |
The From object identifier. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
To Object ID
|
toObjectId | True | string |
The To object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Association Category
|
results.associationSpec.associationCategory | string |
The association category. |
|
Association Type ID
|
results.associationSpec.associationTypeId | string |
The association type identifier. |
|
ID
|
results.from.id | string |
The identifier. |
|
ID
|
results.to.id | string |
The identifier. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Errors
|
numErrors | string |
The number of errors. |
|
Requested At
|
requestedAt | string |
When requested at. |
|
Errors
|
errors | array of object | |
|
Category
|
errors.category | string |
The category. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
The message. |
|
Sub Category
|
errors.errors.subCategory | string |
The sub category. |
|
Code
|
errors.errors.code | string |
The code. |
|
In
|
errors.errors.in | string |
The in. |
|
Message
|
errors.message | string |
The message. |
|
Status
|
errors.status | string |
The status. |
|
ID
|
errors.id | string |
The identifier. |
Create default associations
Create the default (most generic) association type between two object types.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
ID
|
id | string |
The identifier. |
|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Association Category
|
results.associationSpec.associationCategory | string |
The association category. |
|
Association Type ID
|
results.associationSpec.associationTypeId | string |
The association type identifier. |
|
ID
|
results.from.id | string |
The identifier. |
|
ID
|
results.to.id | string |
The identifier. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Errors
|
numErrors | string |
The number of errors. |
|
Requested At
|
requestedAt | string |
When requested at. |
|
Errors
|
errors | array of object | |
|
Category
|
errors.category | string |
The category. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
The message. |
|
Sub Category
|
errors.errors.subCategory | string |
The sub category. |
|
Code
|
errors.errors.code | string |
The code. |
|
In
|
errors.errors.in | string |
The in. |
|
Message
|
errors.message | string |
The message. |
|
Status
|
errors.status | string |
The status. |
|
ID
|
errors.id | string |
The identifier. |
Create quote
Create a quote with the given properties and return a copy of the object, including the identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
|
|
elit_26
|
elit_26 | string |
elit_26. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Delete a card
Permanently deletes a card definition with the given identifier. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app identifier. |
|
Card ID
|
cardId | True | string |
The card identifier. |
Returns
- response
- string
Delete a company to follow GDPR
Permanently delete a company and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a contact to follow GDPR
Permanently delete a contact and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a deal to follow GDPR
Permanently delete a deal and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a discount to follow GDPR
Permanently delete a discount and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a fee to follow GDPR
Permanently delete a fee and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a feedback submission to follow GDPR
Permanently delete a feedback submission and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a goal target to follow GDPR
Permanently delete a goal target and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a line item to follow GDPR
Permanently delete a line item and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a product to follow GDPR
Permanently delete a product and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a quote to follow GDPR
Permanently delete a quote and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a tax to follow GDPR
Permanently delete a tax and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete a ticket to follow GDPR
Permanently delete a ticket and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete all records from a list
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
listId | True | string |
The list identifier. |
Returns
- response
- string
Delete an object type to follow GDPR
Permanently delete an object type and all associated content to follow GDPR. Use optional property 'ID Property' 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | string |
The object identifier. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
- response
- string
Delete associations
Deletes all associations between two records.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
To Object ID
|
toObjectId | True | string |
The To object identifier. |
Returns
- response
- string
Delete batch associations
Batch delete associations for objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
ID
|
id | string |
The identifier. |
|
|
ID
|
id | string |
The identifier. |
Returns
- response
- string
Delete specific association labels
Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
ID
|
id | string |
The identifier. |
|
|
ID
|
id | string |
The identifier. |
|
|
Association Category
|
associationCategory | string |
The association category. |
|
|
Association Type ID
|
associationTypeId | string |
The association type identifier. |
Returns
- response
- string
Fetch list 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Before
|
before | string |
The before. |
|
|
Limit
|
limit | string |
The limit. |
|
|
List ID
|
listId | True | string |
The list identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of string |
The results. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
|
Before
|
paging.prev.before | string |
The before. |
|
Link
|
paging.prev.link | string |
The link. |
Get a batch of contacts by ID
Retrieve a batch of contacts by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of deals by ID
Retrieve a batch of deals by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of discounts by ID
Retrieve a batch of discounts by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of feedback submissions by ID
Retrieve a batch of feedback submissions by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of fees by ID
Retrieve a batch of fees by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of goal targets by ID
Retrieve a batch of goal targets by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of line items by ID
Retrieve a batch of line items by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of objects by ID
Retrieve a batch of objects by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
Object Type
|
objectType | True | string |
The object type. |
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of products by ID
Retrieve a batch of products by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of quotes by ID
Retrieve a batch of quotes by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of taxes by ID
Retrieve a batch of taxes by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a batch of tickets by ID
Retrieve a batch of tickets by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get a card
Returns the definition for a card with the given identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app identifier. |
|
Card ID
|
cardId | True | string |
The card identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
The base URL addresses. |
|
Audit History
|
auditHistory | array of object | |
|
Action Type
|
auditHistory.actionType | string |
The action type. |
|
Application ID
|
auditHistory.applicationId | string |
The application identifier. |
|
Authorization Source
|
auditHistory.authSource | string |
The authorization source. |
|
Changed At
|
auditHistory.changedAt | string |
When changed at. |
|
Initiating User ID
|
auditHistory.initiatingUserId | string |
The initiating user identifier. |
|
Object Type ID
|
auditHistory.objectTypeId | string |
The object type identifier. |
|
Properties
|
display.properties | array of object | |
|
Data Type
|
display.properties.dataType | string |
The data type. |
|
Label
|
display.properties.label | string |
The label. |
|
Name
|
display.properties.name | string |
The name. |
|
Options
|
display.properties.options | array of object | |
|
Label
|
display.properties.options.label | string |
The label. |
|
Name
|
display.properties.options.name | string |
The name. |
|
Type
|
display.properties.options.type | string |
The type. |
|
Object Types
|
fetch.objectTypes | array of object | |
|
Name
|
fetch.objectTypes.name | string |
The name. |
|
Properties To Send
|
fetch.objectTypes.propertiesToSend | array of string |
The properties to send. |
|
Target URL
|
fetch.targetUrl | string |
The target URL address. |
|
ID
|
id | string |
The identifier. |
|
Title
|
title | string |
The title. |
|
Created At
|
createdAt | string |
When created at. |
|
Updated At
|
updatedAt | string |
When updated at. |
Get a company by ID
Retrieve an object identified by companyidentifier. companyId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Company ID
|
companyId | True | string |
The company identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a contact by ID
Retrieve an object identified by contactidentifier. contactId refers to the internal object identifier. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
Contact ID
|
contactId | True | string |
The contact identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
|
Results
|
associations.etc.results | array of object | |
|
ID
|
associations.etc.results.id | string |
The identifier. |
|
Type
|
associations.etc.results.type | string |
The type. |
|
After
|
associations.etc.paging.next.after | string |
The after page. |
|
Link
|
associations.etc.paging.next.link | string |
The link page. |
|
Before
|
associations.etc.paging.prev.before | string |
The before page. |
|
Link
|
associations.etc.paging.prev.link | string |
The link page. |
Get a deal
Retrieve an object identified by dealidentifier. dealId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Deal ID
|
dealId | True | string |
The deal identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a discount
Retrieve an object identified by discountidentifier. discountId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Discount ID
|
discountId | True | string |
The discount identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a fee by ID
Retrieve an object identified by feeidentifier. feeId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Fee ID
|
feeId | True | string |
The fee identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a feedback submission
Retrieve an object identified by feedbackSubmissionidentifier. feedbackSubmissionId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Feedback Submission ID
|
feedbackSubmissionId | True | string |
The feedback submission identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a goal target by ID
Retrieve an object identified by goalTargetidentifier. goalTargetId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Goal Target ID
|
goalTargetId | True | string |
The goal target identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a product
Retrieve an object identified by productidentifier. productId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Product ID
|
productId | True | string |
The product identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a quote by ID
Retrieve an object identified by quoteidentifier. quoteId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Quote ID
|
quoteId | True | string |
The quote identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a tax by ID
Retrieve an object identified by taxidentifier. taxId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Tax ID
|
taxId | True | string |
The tax identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get a ticket
Retrieve an object identified by ticketidentifier. ticketId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Ticket ID
|
ticketId | True | string |
The ticket identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get active imports
Returns a paged list of active imports for this account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Before
|
before | string |
The before. |
|
|
Limit
|
limit | string |
The limit. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
File IDs
|
results.metadata.fileIds | array of string |
The file identifiers. |
|
Object Lists
|
results.metadata.objectLists | array of object | |
|
List ID
|
results.metadata.objectLists.listId | string |
The list identifier. |
|
Object Type
|
results.metadata.objectLists.objectType | string |
The object type. |
|
Opt-Out Import
|
results.optOutImport | string |
The opt-out import. |
|
State
|
results.state | string |
The state. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Template ID
|
results.importTemplate.templateId | string |
The template identifier. |
|
Template Type
|
results.importTemplate.templateType | string |
The template type. |
|
Import Source
|
results.importSource | string |
The import source. |
|
Import Name
|
results.importName | string |
The import name. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
|
Before
|
paging.prev.before | string |
The before. |
|
Link
|
paging.prev.link | string |
The link. |
Get all cards
Returns a list of cards for a given app.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Base URLs
|
results.actions.baseUrls | array of string |
The base URL addresses. |
|
Audit History
|
results.auditHistory | array of object | |
|
Action Type
|
results.auditHistory.actionType | string |
The action type. |
|
Application ID
|
results.auditHistory.applicationId | string |
The application identifier. |
|
Auth Source
|
results.auditHistory.authSource | string |
The authorization source. |
|
Changed At
|
results.auditHistory.changedAt | string |
When changed at. |
|
Initiating User ID
|
results.auditHistory.initiatingUserId | string |
The initiating user identifier. |
|
Object Type ID
|
results.auditHistory.objectTypeId | string |
The object type identifier. |
|
Properties
|
results.display.properties | array of object | |
|
Data Type
|
results.display.properties.dataType | string |
The data type. |
|
Label
|
results.display.properties.label | string |
The label. |
|
Name
|
results.display.properties.name | string |
The name. |
|
Options
|
results.display.properties.options | array of object | |
|
Label
|
results.display.properties.options.label | string |
The label. |
|
Name
|
results.display.properties.options.name | string |
The name. |
|
Type
|
results.display.properties.options.type | string |
The type. |
|
Object Types
|
results.fetch.objectTypes | array of object | |
|
Name
|
results.fetch.objectTypes.name | string |
The name. |
|
Properties To Send
|
results.fetch.objectTypes.propertiesToSend | array of string |
The properties to send. |
|
Target URL
|
results.fetch.targetUrl | string |
The target URL address. |
|
ID
|
results.id | string |
The identifier. |
|
Title
|
results.title | string |
The title. |
|
Created At
|
results.createdAt | string |
When created at. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
Get an object by ID
Retrieve an object identified by objectidentifier. objectId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get an owner by ID
Retrieve an owner by given identifier or useridentifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
Owner ID
|
ownerId | True | string |
The owner identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Archived
|
archived | boolean |
Whether archived. |
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Email
|
string |
The email address. |
|
|
First Name
|
firstName | string |
The first name. |
|
Last Name
|
lastName | string |
The last name. |
|
User ID
|
userId | string |
The user identifier. |
|
Teams
|
teams | array of object | |
|
ID
|
teams.id | string |
The identifier. |
|
Name
|
teams.name | string |
The name. |
|
Primary
|
teams.primary | string |
The primary. |
Get companies
Retrieve a page of companies. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get companies by ID
Retrieve a batch of companies by internal identifier, or unique property values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID
|
id | string |
The identifier. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Properties With History
|
propertiesWithHistory | array of string |
The properties with history object. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get contacts
Retrieve a page of contacts. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get deals
Retrieve a page of deals. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get fees
Retrieve a page of fees. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get goal targets
Retrieve a page of goal targets. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get import errors
Retrieve a list of errors for an import.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Import ID
|
importId | True | string |
The import identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
Error Type
|
results.errorType | string |
The error type. |
|
ID
|
results.id | string |
The identifier. |
|
File ID
|
results.sourceData.fileId | string |
The file identifier. |
|
Line Number
|
results.sourceData.lineNumber | string |
The line number. |
|
Row Data
|
results.sourceData.rowData | array of string |
The row data. |
|
Page Name
|
results.sourceData.pageName | string |
The page name. |
|
Object Type
|
results.objectType | string |
The object type. |
|
Invalid Value
|
results.invalidValue | string |
The invalid value. |
|
Extra Context
|
results.extraContext | string |
The extra context. |
|
Object Type ID
|
results.objectTypeId | string |
The object type identifier. |
|
Known Column Number
|
results.knownColumnNumber | string |
The known column number. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
Get line item
Retrieve an object identified by lineItemidentifier. lineItemId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Line Item ID
|
lineItemId | True | string |
The line item identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Get line items
Retrieve a page of line items. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get objects
Retrieve a page of objects. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
|
|
Object Type
|
objectType | True | string |
The object type. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get owners
Retrieve a list of owners.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Email
|
True | string |
The email address. |
|
|
After
|
after | string |
The after page. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Email
|
results.email | string |
The email address. |
|
First Name
|
results.firstName | string |
The first name. |
|
Last Name
|
results.lastName | string |
The last name. |
|
User ID
|
results.userId | string |
The user identifier. |
|
Teams
|
results.teams | array of object | |
|
ID
|
results.teams.id | string |
The identifier. |
|
Name
|
results.teams.name | string |
The name. |
|
Primary
|
results.teams.primary | string |
The primary. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get products
Retrieve a page of products. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after page. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get sample card detail 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.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Total Count
|
totalCount | string |
The total count. |
|
All Items Link URL
|
allItemsLinkUrl | string |
The all items link URL address. |
|
Card Label
|
cardLabel | string |
The card label. |
|
Secondary
|
topLevelActions.secondary | array of object | |
|
HTTP Method
|
topLevelActions.secondary.httpMethod | string |
The HTTP method. |
|
Property Names Included
|
topLevelActions.secondary.propertyNamesIncluded | array of string |
The property names included. |
|
Type
|
topLevelActions.secondary.type | string |
The type. |
|
URL
|
topLevelActions.secondary.url | string |
The URL address. |
|
Cancel Button Label
|
topLevelActions.secondary.confirmation.cancelButtonLabel | string |
The cancel button label. |
|
Confirm Button Label
|
topLevelActions.secondary.confirmation.confirmButtonLabel | string |
The confirm button label. |
|
Prompt
|
topLevelActions.secondary.confirmation.prompt | string |
The prompt. |
|
Label
|
topLevelActions.secondary.label | string |
The label. |
|
Height
|
topLevelActions.settings.height | string |
The height. |
|
Property Names Included
|
topLevelActions.settings.propertyNamesIncluded | array of string |
The property names included. |
|
Type
|
topLevelActions.settings.type | string |
The type. |
|
URL
|
topLevelActions.settings.url | string |
The URL address. |
|
Width
|
topLevelActions.settings.width | string |
The width. |
|
Label
|
topLevelActions.settings.label | string |
The label. |
|
HTTP Method
|
topLevelActions.primary.httpMethod | string |
The HTTP method. |
|
Property Names Included
|
topLevelActions.primary.propertyNamesIncluded | array of string |
The property names included. |
|
Type
|
topLevelActions.primary.type | string |
The type. |
|
URL
|
topLevelActions.primary.url | string |
The URL address. |
|
Cancel Button Label
|
topLevelActions.primary.confirmation.cancelButtonLabel | string |
The cancel button label. |
|
Confirm Button Label
|
topLevelActions.primary.confirmation.confirmButtonLabel | string |
The confirm button label. |
|
Prompt
|
topLevelActions.primary.confirmation.prompt | string |
The prompt. |
|
Label
|
topLevelActions.primary.label | string |
The label. |
|
Sections
|
sections | array of object | |
|
Actions
|
sections.actions | array of object | |
|
HTTP Method
|
sections.actions.httpMethod | string |
The HTTP method. |
|
Property Names Included
|
sections.actions.propertyNamesIncluded | array of string |
The property names included. |
|
Type
|
sections.actions.type | string |
The type. |
|
URL
|
sections.actions.url | string |
The URL address. |
|
Cancel Button Label
|
sections.actions.confirmation.cancelButtonLabel | string |
The cancel button label. |
|
Confirm Button Label
|
sections.actions.confirmation.confirmButtonLabel | string |
The confirm button label. |
|
Prompt
|
sections.actions.confirmation.prompt | string |
The prompt. |
|
Label
|
sections.actions.label | string |
The label. |
|
ID
|
sections.id | string |
The identifier. |
|
Title
|
sections.title | string |
The title. |
|
Tokens
|
sections.tokens | array of object | |
|
Value
|
sections.tokens.value | string |
The value. |
|
Name
|
sections.tokens.name | string |
The name. |
|
Label
|
sections.tokens.label | string |
The label. |
|
Data Type
|
sections.tokens.dataType | string |
The data type. |
|
Link URL
|
sections.linkUrl | string |
The link URL address. |
|
Response Version
|
responseVersion | string |
The response version. |
Get task ID status
Retrieve the status for a task identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
taskId | True | string |
The task identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Result
|
result | string |
The result. |
|
Errors
|
numErrors | string |
The number of errors. |
|
Errors
|
errors | array of object | |
|
Category
|
errors.category | string |
The category. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
The message. |
|
In
|
errors.errors.in | string |
The in. |
|
Code
|
errors.errors.code | string |
The code. |
|
Sub Category
|
errors.errors.subCategory | string |
The sub category. |
|
Message
|
errors.message | string |
The message. |
|
Status
|
errors.status | string |
The status. |
|
ID
|
errors.id | string |
The identifier. |
|
Requested At
|
requestedAt | string |
When requested at. |
Get taxes
Retrieve a page of taxes. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Get the information on any import
A complete summary of an import record, including any updates.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Import ID
|
importId | True | string |
The import identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
File IDs
|
metadata.fileIds | array of string |
The file identifiers. |
|
Object Lists
|
metadata.objectLists | array of object | |
|
List ID
|
metadata.objectLists.listId | string |
The list identifier. |
|
Object Type
|
metadata.objectLists.objectType | string |
The object type. |
|
Opt-Out Import
|
optOutImport | string |
The opt-out import. |
|
State
|
state | string |
The state. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Template ID
|
importTemplate.templateId | string |
The template identifier. |
|
Template Type
|
importTemplate.templateType | string |
The template type. |
|
Import Source
|
importSource | string |
The import source. |
|
Import Name
|
importName | string |
The import name. |
Get tickets
Retrieve a page of tickets. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
List association types
List all the valid association types available between two object types.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
The identifier. |
|
Name
|
results.name | string |
The name. |
List associations for an object
List all associations of an object by object type. Limit 500 per call.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Association Types
|
results.associationTypes | array of object | |
|
Category
|
results.associationTypes.category | string |
The category. |
|
Type ID
|
results.associationTypes.typeId | string |
The type identifier. |
|
Label
|
results.associationTypes.label | string |
The label. |
|
To Object ID
|
results.toObjectId | string |
The To object identifier. |
|
After
|
paging.next.after | string |
The after. |
|
Link
|
paging.next.link | string |
The link. |
List discounts
Retrieve a page of discounts. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
List feedback submissions
Retrieve a page of feedback submissions. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
List quotes
Retrieve a page of quotes. Control what is returned via the properties query parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
The limit. |
|
|
After
|
after | string |
The after. |
|
|
Properties
|
properties | string |
The properties. |
|
|
Properties with History
|
propertiesWithHistory | string |
The properties with history. |
|
|
Associations
|
associations | string |
The associations. |
|
|
Archived
|
archived | boolean |
Whether to return only results that have been archived. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Merge two companies
Merge two companies with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two contact
Merge two contacts with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two deals
Merge two deals with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two discounts
Merge two discounts with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two feedback submissions
Merge two feedback submissions with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two fees
Merge two fees with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two goal targets
Merge two goal targets with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two line items
Merge two line items with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two objects
Merge two objects with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two products
Merge two products with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two quotes
Merge two quotes with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two taxes
Merge two taxes with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Merge two tickets
Merge two tickets with same type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object identifier To Merge
|
objectIdToMerge | string |
The object identifier to merge. |
|
|
Primary object ID
|
primaryObjectId | string |
The primary object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Read batch associations
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 objectidentifier. The 'link' field is deprecated and should be ignored.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From Object Type
|
fromObjectType | True | string |
The From object type. |
|
To Object Type
|
toObjectType | True | string |
The To object type. |
|
ID
|
id | string |
The identifier. |
|
|
After
|
after | string |
The after link. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
ID
|
results.from.id | string |
The identifier. |
|
To
|
results.to | array of object | |
|
Association Types
|
results.to.associationTypes | array of object | |
|
Category
|
results.to.associationTypes.category | string |
The category. |
|
Type ID
|
results.to.associationTypes.typeId | string |
The type identifier. |
|
Label
|
results.to.associationTypes.label | string |
The label. |
|
To Object ID
|
results.to.toObjectId | string |
The To object identifier. |
|
After
|
results.paging.next.after | string |
The after link. |
|
Link
|
results.paging.next.link | string |
The link. |
|
Before
|
results.paging.prev.before | string |
The before link. |
|
Link
|
results.paging.prev.link | string |
The link. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Remove records from a list
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List ID
|
listId | True | string |
The list identifier. |
|
body
|
body | True | array of string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Record IDs Missing
|
recordIdsMissing | array of string |
The record identifiers missing. |
|
Record IDs Removed
|
recordIdsRemoved | array of string |
The record identifiers removed. |
|
Record IDs Added
|
recordsIdsAdded | array of string |
The record identifiers added. |
Search by object type
Retrieve a list of objects by object type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search companies
Retrieve a list of companies.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search deals
Retrieve a list of deals.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search discounts
Retrieve a list of discounts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search feedback submissions
Retrieve a list of feedback submissions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search for contacts
Retrieve a list of contacts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search for fees
Retrieve a list of fees.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search goal targets
Retrieve a list of goal targets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search line items
Retrieve a list of line items.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search lists
Search lists by list name or page through all lists by providing an empty query value.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Additional Properties
|
additionalProperties | array of string |
The additional properties. |
|
|
Offset
|
offset | string |
The offset. |
|
|
Query
|
query | string |
The query. |
|
|
Count
|
count | string |
The count. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Has More
|
hasMore | boolean |
Whether has more. |
|
Lists
|
lists | array of object | |
|
List ID
|
lists.listId | string |
The list identifier. |
|
List Version
|
lists.listVersion | string |
The list version. |
|
Name
|
lists.name | string |
The name. |
|
Object Type ID
|
lists.objectTypeId | string |
The object type identifier. |
|
Processing Status
|
lists.processingStatus | string |
The processing status. |
|
Processing Type
|
lists.processingType | string |
The processing type. |
|
Updated By ID
|
lists.updatedById | string |
The updated by identifier. |
|
Filters Updated At
|
lists.filtersUpdatedAt | string |
When the filters were updated at. |
|
Created At
|
lists.createdAt | string |
When created at. |
|
Deleted At
|
lists.deletedAt | string |
When deleted at. |
|
Created By ID
|
lists.createdById | string |
The created by identifier. |
|
Updated At
|
lists.updatedAt | string |
When updated at. |
|
Offset
|
offset | string |
The offset. |
|
Total
|
total | string |
The total. |
Search products
Retrieve a list of products.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search quotes
Retrieve a list of quotes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search taxes
Retrieve a list of taxes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Search tickets
Retrieve a list of tickets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
After
|
after | string |
The after page. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Limit
|
limit | string |
The limit. |
|
|
Properties
|
properties | array of string |
The properties object. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
|
|
Query
|
query | string |
The query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Total
|
total | string |
The total. |
|
After
|
paging.next.after | string |
The after page. |
|
Link
|
paging.next.link | string |
The link. |
Start a new import
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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Content-Type. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
File IDs
|
metadata.fileIds | array of string |
The file identifiers. |
|
Object Lists
|
metadata.objectLists | array of object | |
|
List ID
|
metadata.objectLists.listId | string |
The list identifier. |
|
Object Type
|
metadata.objectLists.objectType | string |
The object type. |
|
Opt-Out Import
|
optOutImport | string |
The opt-out import. |
|
State
|
state | string |
The state. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Template ID
|
importTemplate.templateId | string |
The template identifier. |
|
Template Type
|
importTemplate.templateType | string |
The template type. |
|
Import Source
|
importSource | string |
The import source. |
|
Import Name
|
importName | string |
The import name. |
Start an export
Begins exporting CRM data for the portal as specified in the request body.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Export Name
|
exportName | string |
The export name. |
|
|
Export Type
|
exportType | string |
The export type. |
|
|
Format
|
format | string |
The format. |
|
|
Language
|
language | string |
The language. |
|
|
Object Properties
|
objectProperties | array of string |
The object properties. |
|
|
Object Type
|
objectType | string |
The object tyep. |
|
|
Associated Object Type
|
associatedObjectType | string |
The associated object type. |
|
|
Operator
|
operator | string |
The operator. |
|
|
Property Name
|
propertyName | string |
The property name. |
|
|
Value
|
value | string |
The value. |
|
|
High Value
|
highValue | string |
The high value. |
|
|
Values
|
values | array of string |
The values. |
|
|
Query
|
query | string |
The query. |
|
|
Sorts
|
sorts | array of string |
The sorts. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Update a batch of companies
Update a batch of companies.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of contacts
Update a batch of contacts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of deals
Update a batch of deals.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of discounts
Update a batch of discounts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of feedback submissions
Update a batch of feedback submissions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of fees
Update a batch of fees.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of goal targets
Update a batch of goal targets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of line items
Update a batch of line items.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of objects
Update a batch of objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Object Type
|
objectType | True | string |
The object type. |
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of products
Update a batch of products.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of quotes
Update a batch of quotes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of taxes
Update a batch of taxes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a batch of tickets
Update a batch of tickets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Completed At
|
completedAt | string |
When completed at. |
|
Results
|
results | array of object | |
|
Created At
|
results.createdAt | string |
When created at. |
|
ID
|
results.id | string |
The identifier. |
|
Updated At
|
results.updatedAt | string |
When updated at. |
|
Archived
|
results.archived | boolean |
Whether archived. |
|
Archived At
|
results.archivedAt | string |
When archived at. |
|
Started At
|
startedAt | string |
When started at. |
|
Status
|
status | string |
The status. |
|
Requested At
|
requestedAt | string |
When requested at. |
Update a card
Update a card definition with new details.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
The app identifier. |
|
Card ID
|
cardId | True | string |
The card identifier. |
|
Title
|
title | string |
The title. |
|
|
Name
|
name | string |
The name. |
|
|
Properties To Send
|
propertiesToSend | array of string |
The properties to send. |
|
|
Card Type
|
cardType | string |
The card type. |
|
|
Target URL
|
targetUrl | string |
The target URL address. |
|
|
Serverless Function
|
serverlessFunction | string |
The serverless function. |
|
|
Data Type
|
dataType | string |
The data type. |
|
|
Label
|
label | string |
The label. |
|
|
Name
|
name | string |
The name. |
|
|
Label
|
label | string |
The label. |
|
|
Name
|
name | string |
The name. |
|
|
Type
|
type | string |
The type. |
|
|
Base URLs
|
baseUrls | array of string |
The base URL addresses. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
The base URL addresses. |
|
Audit History
|
auditHistory | array of object | |
|
Action Type
|
auditHistory.actionType | string |
The action type. |
|
Application ID
|
auditHistory.applicationId | string |
The application identifier. |
|
Authorization Source
|
auditHistory.authSource | string |
The authorization source. |
|
Changed At
|
auditHistory.changedAt | string |
When changed at. |
|
Initiating User ID
|
auditHistory.initiatingUserId | string |
The initiating user identifier. |
|
Object Type ID
|
auditHistory.objectTypeId | string |
The object type identifier. |
|
Properties
|
display.properties | array of object | |
|
Data Type
|
display.properties.dataType | string |
The data type. |
|
Label
|
display.properties.label | string |
The label. |
|
Name
|
display.properties.name | string |
The name. |
|
Options
|
display.properties.options | array of object | |
|
Label
|
display.properties.options.label | string |
The label. |
|
Name
|
display.properties.options.name | string |
The name. |
|
Type
|
display.properties.options.type | string |
The type. |
|
Object Types
|
fetch.objectTypes | array of object | |
|
Name
|
fetch.objectTypes.name | string |
The name. |
|
Properties To Send
|
fetch.objectTypes.propertiesToSend | array of string |
The properties to send. |
|
Target URL
|
fetch.targetUrl | string |
The target URL address. |
|
ID
|
id | string |
The identifier. |
|
Title
|
title | string |
The title. |
|
Created At
|
createdAt | string |
When created at. |
|
Updated At
|
updatedAt | string |
When updated at. |
Update a company by ID
Perform a partial update of an object identified by companyidentifier. companyId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Company ID
|
companyId | True | string |
The company identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a contact by ID
Perform a partial update of an object identified by contactidentifier. contactId refers to the internal object identifier. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact ID
|
contactId | True | string |
The contact identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a deal
Perform a partial update of an object identified by dealidentifier. dealId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Deal ID
|
dealId | True | string |
The deal identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a discount
Perform a partial update of an object identified by discountidentifier. discountId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Discount ID
|
discountId | True | string |
The discount identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a fee by ID
Perform a partial update of an object identified by feeidentifier. feeId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Fee ID
|
feeId | True | string |
The fee identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a feedback submission
Perform a partial update of an object identified by feedbackSubmissionidentifier. feedbackSubmissionId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Feedback Submission ID
|
feedbackSubmissionId | True | string |
The feedback submission identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a goal target
Perform a partial update of an object identified by goalTargetidentifier. goalTargetId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Goal Target ID
|
goalTargetId | True | string |
The goal target identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a line item
Perform a partial update of an object identified by lineItemidentifier. lineItemId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Line Item ID
|
lineItemId | True | string |
The line item identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a product
Perform a partial update of an object identified by productidentifier. productId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Product ID
|
productId | True | string |
The product identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a quote
Perform a partial update of an object identified by quoteidentifier. quoteId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Quote ID
|
quoteId | True | string |
The quote identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a tax
Perform a partial update of an object identified by taxidentifier. taxId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Tax ID
|
taxId | True | string |
The tax identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update a ticket
Perform a partial update of an object identified by ticketidentifier. ticketId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Ticket ID
|
ticketId | True | string |
The ticket identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Update an object
Perform a partial update of an object identified by objectidentifier. objectId refers to the internal object identifier by default, or optionally any unique property value as specified by the idProperty query parameter. 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
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID Property
|
idProperty | string |
The identifier property. |
|
|
Object Type
|
objectType | True | string |
The object type. |
|
Object ID
|
objectId | True | string |
The object identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | string |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Updated At
|
updatedAt | string |
When updated at. |
|
Archived
|
archived | boolean |
Whether archived. |
|
Archived At
|
archivedAt | string |
When archived at. |
Definitions
string
This is the basic data type 'string'.