Import CRM Records
| Method | Description |
|---|---|
| getRecords | Retrieving all records from a specific entity. |
| deleteRecord | Deleting records from a specific entity |
| runProcess | Run a process on records |
| insertRecord | Insert records to a specific entity |
| updateRecord | Update records from a specific entity |
getRecords
Retrieving all records from a specific entity. The records can be filtered by a range for any field you want
| REST API | crmApi/getRecords |
| Parameters | Description | Parameter Options/value | Default value |
|---|---|---|---|
| entityName Required | Entity Name | string | |
| filter Required | An array of the fields to filter | See table below |
JSON Body Example
{
"entityName": …,
"filter":
{
"…": {
"from": "…",
"until": "…"
},
"…": {
"from": "…",
"until": "…"
},
}
}
FieldName-stock
The following parameters should be included in a filter object (see example below)
| FieldName-stock | Type | Description | תיאור | Default Value |
|---|---|---|---|---|
| from Required | CRM field type see note below | הערך הנמוך ביותר | Lowest value | |
| until Required | CRM field type | הערך הגבוה ביותר | Highest value |
CRM field type: For each field, ensure the data type defined in the software is matched (number, string, list, date, datetime, or link). Dates should be sent in the format YYYY-MM-DD, for example, 2000-01-01. Datetimes should be sent in the format YYYY-MM-DD hh:mm, for example, 2000-01-01 11:06:28
JSON Example
{
"entityName": "לידים",
"filter":
{
"שם": {
"from": "A",
"until": "zzzzzz"
},
"מזהה" : {
"from": "1",
"until": "9999999"
},
"תאריך יצירה": {
"from": "2000-09-15 11:06:28",
"until": "2025-09-15 11:06:28"
}
}
}
deleteRecord
Deleting records from a specific entity. The records can be filtered by a range for any field.
| REST API | crmApi/deleteRecord |
| Parameters | Description | Parameter Options/value | Default value |
|---|---|---|---|
| entityName Required | Entity Name | string | |
| filter Required | An array of the fields to filter | See table below |
JSON Body Example
{
"entityName": …,
"filter":
{
"…": {
"from": "…",
"until": "…"
},
"…": {
"from": "…",
"until": "…"
},
}
}
FieldName-stock
The following parameters should be included in a filter object (see example below)
| FieldName-stock | Type | Description | תי אור | Default Value |
|---|---|---|---|---|
| from Required | CRM field type see note below | הערך הנמוך ביותר | Lowest value | |
| until Required | CRM field type | הערך הגבוה ביותר | Highest value |
JSON Example
{
"entityName": "לידים",
"filter":
{
"שם": {
"from": "יניב",
"until": "יניב"
}
}
}
runProcess
| REST API | crmApi/runProcess |
| Parameters | Description | Parameter Options/value | Default value |
|---|---|---|---|
| processName Required | Process Name | string | |
| recordID | An array of the fields to filter | The record on which the process is running | All the records |
JSON Example
{
"processName" : "שליחת מייל ללקוח",
"recordID" : "31127"
}
insertRecord
| REST API | crmApi/insertRecord |
| Parameters | Description | Parameter Options/value | Default value |
|---|---|---|---|
| entityName Required | Entity Name | string | |
| data Required | An array of the fields to insert | insert object |
JSON Example
{ "entityName" : "לידים", "data" : [ { "חיים כהן" :"שם", "דואר אלקטרוני": "example@gmail.com", "מעוניין ב-": "CRM", "טלפון": "0555555555" }, { "שם": "מאור לוי", "דואר אלקטרוני": "mail@gmail.com", "מעוניין ב-": "שיחת טלפון" "טלפון": "0555555555" } ] }
updateRecord
| REST API | crmApi/updateRecord |
| Parameters | Description | Parameter Options/value | Default value |
|---|---|---|---|
| entityName Required | Entity Name | string | |
| data Required | An array of the fields to update | insert object |
JSON Example
{
"entityName": "לידים",
"data": [
{
"recordID": "31128",
"details":
{
"שם": "noa"
}
},
{
"recordID": "30379",
"details":
{
"שם": "shira"
}
}
]
}