@datafire/data2crm v6.0.0
@datafire/data2crm
Client library for Data2CRM.API
Installation and Usage
npm install --save @datafire/data2crm
let data2crm = require('@datafire/data2crm').create();
.then(data => {
console.log(data);
});
Description
Actions
getAccountCollection
Returns all accounts from the system
data2crm.getAccountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items AccountEntity
createAccountEntity
Add account into the system
data2crm.createAccountEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required AccountEntity
- X-API2CRM-USER-KEY required
Output
- output AccountEntityRelation
getAccountAggregate
Returns aggregate for accounts
data2crm.getAccountAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteAccountCollectionBulk
DELETE bulk for account
data2crm.deleteAccountCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createAccountEntityBulk
Add account into the system
data2crm.createAccountEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateAccountEntityBulk
PUT bulk for account
data2crm.updateAccountEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getAccountCountCollection
Count all accounts from the system
data2crm.getAccountCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getAccountDescribe
Returns describe for accounts
data2crm.getAccountDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output AccountDescribe
deleteAccountEntity
Delete account information
data2crm.deleteAccountEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"account_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - account_id required
string
: Account Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getAccountEntity
Return account information
data2crm.getAccountEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"account_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - account_id required
string
: Account Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output AccountEntity
updateAccountEntity
Update account information
data2crm.updateAccountEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"account_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - account_id required
string
: Account Identifier - body required AccountEntity
- X-API2CRM-USER-KEY required
Output
- output AccountEntityRelation
getApplicationCollection
Returns all applications from the system
data2crm.getApplicationCollection({
"X-API2CRM-USER-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields
- X-API2CRM-USER-KEY required
Output
- output
array
- items ApplicationEntityList
createApplicationEntity
Add application into the system
data2crm.createApplicationEntity({
"X-API2CRM-USER-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key - body required ApplicationEntityWrite
- X-API2CRM-USER-KEY required
Output
- output ApplicationEntityRelation
getApplicationCountCollection
Count all applications from the system
data2crm.getApplicationCountCollection({
"X-API2CRM-USER-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key
- X-API2CRM-USER-KEY required
Output
- output Count
deleteApplicationEntity
Delete application information
data2crm.deleteApplicationEntity({
"X-API2CRM-USER-KEY": "",
"key": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key - key required
string
: Application key
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getApplicationEntity
Return application information
data2crm.getApplicationEntity({
"X-API2CRM-USER-KEY": "",
"key": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key - key required
string
: Application key - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output ApplicationEntity
updateApplicationEntity
Update application information
data2crm.updateApplicationEntity({
"X-API2CRM-USER-KEY": "",
"key": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: API2CRM user key - key required
string
: Application key - body required ApplicationEntityWrite
- X-API2CRM-USER-KEY required
Output
- output ApplicationEntityRelation
getAttachmentCollection
Returns all attachments from the system
data2crm.getAttachmentCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items AttachmentEntityList
createAttachmentEntity
Add attachment into the system
data2crm.createAttachmentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required AttachmentEntityWrite
- X-API2CRM-USER-KEY required
Output
- output AttachmentEntityRelation
getAttachmentAggregate
Returns aggregate for attachments
data2crm.getAttachmentAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteAttachmentCollectionBulk
DELETE bulk for attachment
data2crm.deleteAttachmentCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createAttachmentEntityBulk
Add attachment into the system
data2crm.createAttachmentEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateAttachmentEntityBulk
PUT bulk for attachment
data2crm.updateAttachmentEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getAttachmentCountCollection
Count all attachments from the system
data2crm.getAttachmentCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getAttachmentDescribe
Returns describe for attachments
data2crm.getAttachmentDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output AttachmentDescribe
deleteAttachmentEntity
Delete attachment information
data2crm.deleteAttachmentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"attachment_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - attachment_id required
string
: Attachment Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getAttachmentEntity
Return attachment information
data2crm.getAttachmentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"attachment_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - attachment_id required
string
: Attachment Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output AttachmentEntity
updateAttachmentEntity
Update attachment information
data2crm.updateAttachmentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"attachment_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - attachment_id required
string
: Attachment Identifier - body required AttachmentEntityWrite
- X-API2CRM-USER-KEY required
Output
- output AttachmentEntityRelation
getCallCollection
Returns all calls from the system
data2crm.getCallCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items CallEntity
createCallEntity
Add call into the system
data2crm.createCallEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required CallEntity
- X-API2CRM-USER-KEY required
Output
- output CallEntityRelation
getCallAggregate
Returns aggregate for calls
data2crm.getCallAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteCallCollectionBulk
DELETE bulk for call
data2crm.deleteCallCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createCallEntityBulk
Add call into the system
data2crm.createCallEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateCallEntityBulk
PUT bulk for call
data2crm.updateCallEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getCallCountCollection
Count all calls from the system
data2crm.getCallCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getCallDescribe
Returns describe for calls
data2crm.getCallDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output CallDescribe
deleteCallEntity
Delete call information
data2crm.deleteCallEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"call_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - call_id required
string
: Call Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getCallEntity
Return call information
data2crm.getCallEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"call_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - call_id required
string
: Call Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output CallEntity
updateCallEntity
Update call information
data2crm.updateCallEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"call_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - call_id required
string
: Call Identifier - body required CallEntity
- X-API2CRM-USER-KEY required
Output
- output CallEntityRelation
getCampaignCollection
Returns all campaigns from the system
data2crm.getCampaignCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items CampaignEntity
createCampaignEntity
Add campaign into the system
data2crm.createCampaignEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required CampaignEntity
- X-API2CRM-USER-KEY required
Output
- output CampaignEntityRelation
getCampaignAggregate
Returns aggregate for campaigns
data2crm.getCampaignAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteCampaignCollectionBulk
DELETE bulk for campaign
data2crm.deleteCampaignCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createCampaignEntityBulk
Add campaign into the system
data2crm.createCampaignEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateCampaignEntityBulk
PUT bulk for campaign
data2crm.updateCampaignEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getCampaignCountCollection
Count all campaigns from the system
data2crm.getCampaignCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getCampaignDescribe
Returns describe for campaigns
data2crm.getCampaignDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output CampaignDescribe
deleteCampaignEntity
Delete campaign information
data2crm.deleteCampaignEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"campaign_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - campaign_id required
string
: Campaign Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getCampaignEntity
Return campaign information
data2crm.getCampaignEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"campaign_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - campaign_id required
string
: Campaign Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output CampaignEntity
updateCampaignEntity
Update campaign information
data2crm.updateCampaignEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"campaign_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - campaign_id required
string
: Campaign Identifier - body required CampaignEntity
- X-API2CRM-USER-KEY required
Output
- output CampaignEntityRelation
getCaseCollection
Returns all cases from the system
data2crm.getCaseCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items CasesEntity
createCaseEntity
Add case into the system
data2crm.createCaseEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required CasesEntity
- X-API2CRM-USER-KEY required
Output
- output CasesEntityRelation
getCaseAggregate
Returns aggregate for cases
data2crm.getCaseAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteCaseCollectionBulk
DELETE bulk for case
data2crm.deleteCaseCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createCaseEntityBulk
Add case into the system
data2crm.createCaseEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateCaseEntityBulk
PUT bulk for case
data2crm.updateCaseEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getCaseCountCollection
Count all cases from the system
data2crm.getCaseCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getCaseDescribe
Returns describe for cases
data2crm.getCaseDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output CaseDescribe
deleteCaseEntity
Delete case information
data2crm.deleteCaseEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"case_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - case_id required
string
: Case Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getCaseEntity
Return case information
data2crm.getCaseEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"case_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - case_id required
string
: Case Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output CasesEntity
updateCaseEntity
Update case information
data2crm.updateCaseEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"case_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - case_id required
string
: Case Identifier - body required CasesEntity
- X-API2CRM-USER-KEY required
Output
- output CasesEntityRelation
getCommentCollection
Returns all comments from the system
data2crm.getCommentCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items CommentEntity
createCommentEntity
Add comment into the system
data2crm.createCommentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required CommentEntity
- X-API2CRM-USER-KEY required
Output
- output CommentEntityRelation
getCommentAggregate
Returns aggregate for comments
data2crm.getCommentAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteCommentCollectionBulk
DELETE bulk for comment
data2crm.deleteCommentCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createCommentEntityBulk
Add comment into the system
data2crm.createCommentEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateCommentEntityBulk
PUT bulk for comment
data2crm.updateCommentEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getCommentCountCollection
Count all comments from the system
data2crm.getCommentCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getCommentDescribe
Returns describe for comments
data2crm.getCommentDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output CommentDescribe
deleteCommentEntity
Delete comment information
data2crm.deleteCommentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"comment_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - comment_id required
string
: Comment Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getCommentEntity
Return comment information
data2crm.getCommentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"comment_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - comment_id required
string
: Comment Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output CommentEntity
updateCommentEntity
Update comment information
data2crm.updateCommentEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"comment_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - comment_id required
string
: Comment Identifier - body required CommentEntity
- X-API2CRM-USER-KEY required
Output
- output CommentEntityRelation
getContactCollection
Returns all contacts from the system
data2crm.getContactCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items ContactEntity
createContactEntity
Add contact into the system
data2crm.createContactEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required ContactEntity
- X-API2CRM-USER-KEY required
Output
- output ContactEntityRelation
getContactAggregate
Returns aggregate for contacts
data2crm.getContactAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - filter
string
: Filter - pipeline
string
: Pipeline
- X-API2CRM-USER-KEY required
Output
- output Aggregate
deleteContactCollectionBulk
DELETE bulk for contact
data2crm.deleteContactCollectionBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntity
createContactEntityBulk
Add contact into the system
data2crm.createContactEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
updateContactEntityBulk
PUT bulk for contact
data2crm.updateContactEntityBulk({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - body required BulkEntity
- X-API2CRM-USER-KEY required
Output
- output BulkEntityRelation
getContactCountCollection
Count all contacts from the system
data2crm.getContactCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - filter
string
: Filter
- X-API2CRM-USER-KEY required
Output
- output Count
getContactDescribe
Returns describe for contacts
data2crm.getContactDescribe({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime
- X-API2CRM-USER-KEY required
Output
- output ContactDescribe
deleteContactEntity
Delete contact information
data2crm.deleteContactEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"contact_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - contact_id required
string
: Contact Identifier
- X-API2CRM-USER-KEY required
Output
Output schema unknown
getContactEntity
Return contact information
data2crm.getContactEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"contact_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - contact_id required
string
: Contact Identifier - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output ContactEntity
updateContactEntity
Update contact information
data2crm.updateContactEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"contact_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - contact_id required
string
: Contact Identifier - body required ContactEntity
- X-API2CRM-USER-KEY required
Output
- output ContactEntityRelation
getCustomEntityCollection
Returns all custom entities from the system
data2crm.getCustomEntityCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - X-API2CRM-ALL-AS-CUSTOM-ENTITY
string
(values: true): Work with native entity like a custom entity - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output
array
- items CustomEntityEntity
getCustomEntityCountCollection
Count all custom entities from the system
data2crm.getCustomEntityCountCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key
- X-API2CRM-USER-KEY required
Output
- output Count
getCustomEntityEntity
Return custom entity information
data2crm.getCustomEntityEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"custom_entity_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - X-API2CRM-ALL-AS-CUSTOM-ENTITY
string
(values: true): Work with native entity like a custom entity - custom_entity_id required
string
: Custom Field Identifier - fields
string
: Comma-separated list of fields to include in the response
- X-API2CRM-USER-KEY required
Output
- output CustomEntityEntity
getCustomEntityItemCollection
Returns all custom entity items from the system
data2crm.getCustomEntityItemCollection({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"custom_entity_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DATA-ENABLE
string
(values: false, true): Data Enable - X-API2CRM-DATA-IS-FINAL
string
(values: true, false): Data Is Final - X-API2CRM-DATA-STRATEGY
string
(values: simple): Data Strategy - X-API2CRM-DATA-ALWAYS-ACTUAL
string
(values: true): Data Is Actual - X-API2CRM-DATA-ACTUAL-AT
string
: Data Actual At - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - X-API2CRM-ALL-AS-CUSTOM-ENTITY
string
(values: true): Work with native entity like a custom entity - custom_entity_id required
string
: Custom Entity Identifier - page_size
integer
: Amount of results (default: 25) - page
integer
: Page to show (default: 1) - filter
string
: Filter - expand
string
: Expand relations - fields
string
: Comma-separated list of fields to include in the response - sort
string
: Specifies ascending or descending sort on existing fields - unique
string
(values: false, true): Find all unique values for selected field
- X-API2CRM-USER-KEY required
Output
- output
array
- items CustomEntityItemEntity
createCustomEntityItemEntity
Add custom entity item into the system
data2crm.createCustomEntityItemEntity({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"custom_entity_id": "",
"body": {}
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY required
string
: Application Key - X-API2CRM-NATIVE-ENABLE
string
(values: false, true): Return native response - X-API2CRM-DESCRIBE-LIFETIME
string
: Describe lifetime - X-API2CRM-ALL-AS-CUSTOM-ENTITY
string
(values: true): Work with native entity like a custom entity - custom_entity_id required
string
: Custom Entity Identifier - body required CustomEntityItemEntity
- X-API2CRM-USER-KEY required
Output
getCustomEntityItemAggregate
Returns aggregate for custom entity items
data2crm.getCustomEntityItemAggregate({
"X-API2CRM-USER-KEY": "",
"X-API2CRM-APPLICATION-KEY": "",
"custom_entity_id": ""
}, context)
Input
- input
object
- X-API2CRM-USER-KEY required
string
: User Key - X-API2CRM-APPLICATION-KEY **requir
- X-API2CRM-USER-KEY required