ConeCRM API v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
API documentation for ConeCRM
This API provides endpoints for managing customers, contacts, leads, opportunities, and related business processes. All endpoints require authentication using JWT tokens.
Base URLs:
Email: ConeCRM Support License: Proprietary
Authentication
- HTTP Authentication, scheme: bearer JWT token for API authentication
Account
_getAccounts
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/account \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/account HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/account',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/account',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/account', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/account', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/account");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/account", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/account
Get Accounts
Get Accounts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer(int64) | false | Start index |
| limit | query | integer(int64) | false | Maximum limit of Accounts to return |
| search | query | string | false | Search string |
| exclude | query | string(uuid) | false | Exclude Account ID |
| franchise | query | integer(int64) | false | Search with franchise ID |
| sortField | query | string | false | Field to sort by (e.g. name, dateCreated) |
| sortDirection | query | string | false | Sort direction (ASC or DESC) |
Enumerated Values
| Parameter | Value |
|---|---|
| sortDirection | ASC |
| sortDirection | DESC |
Example responses
200 Response
{
"total": 0,
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"customer": {},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"customer": {},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » total | integer | false | none | Total number of accounts |
| » accounts | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | BaseCustomer | false | none | none |
| »»» id | string(uuid) | false | none | The unique identifier (UUID7) |
| »»» primaryEmail | string(email) | false | none | Primary email address |
| »»» secondaryEmail | string(email) | false | none | Secondary email address |
| »»» homePhone | string | false | none | Home phone number |
| »»» workPhone | string | false | none | Work phone number |
| »»» workPhoneExtension | string | false | none | Work phone extension |
| »»» mobilePhone | string | false | none | Mobile phone number |
| »»» address | string | false | none | Street address |
| »»» city | string | false | none | City |
| »»» province | string | false | none | Province/State |
| »»» postalCode | string | false | none | Postal/ZIP code |
| »»» country | string | false | none | Country |
| »»» language | string | false | none | Preferred language |
| »»» isActive | boolean | false | none | Whether the customer is active |
| »»» thirdPartyIds | [allOf] | false | none | List of third party IDs associated with this customer |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | BaseRecord | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | IdEntity | false | none | none |
| »»»»»» id | string(uuid) | false | none | The unique identifier (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | object | false | none | none |
| »»»»»» dateCreated | string(date-time) | false | none | Date when the record was created |
| »»»»»» createdBy | object | false | none | User who created the record |
| »»»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»»» dateModified | string(date-time)¦null | false | none | Date when the record was last modified |
| »»»»»» modifiedBy | object | false | none | User who last modified the record |
| »»»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»»» isDeleted | boolean | false | none | Whether the record has been deleted |
| »»»»»» dateDeleted | string(date-time)¦null | false | none | Date when the record was deleted |
| »»»»»» deletedBy | object | false | none | User who deleted the record |
| »»»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»»» dtype | string | false | none | The discriminator type of the record |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | object | false | none | none |
| »»»»» customer | object | false | none | The customer this third party ID belongs to |
| »»»»»» id | string(uuid) | false | none | The customer ID (UUID7) |
| »»»»» systemName | string | false | none | The name of the third party system |
| »»»»» thirdPartyId | string | false | none | The ID from the third party system |
| »»»»» metadata | string¦null | false | none | Additional metadata for the third party ID |
| »»»»» tenant | object | false | none | The tenant this third party ID belongs to |
| »»»»»» id | string(uuid) | false | none | The tenant ID (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» name | string | false | none | The name of the account |
| »»» primaryContact | Contact | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | BaseCustomer | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | object | false | none | none |
| »»»»» firstName | string | false | none | First name |
| »»»»» lastName | string | false | none | Last name |
| »»»»» companyName | string | false | none | Company name |
| »»»»» civility | string | false | none | Contact's civility |
| »»»»» preferredMethodOfContact | string | false | none | Preferred method of contact |
| »»»»» accounts | [allOf] | false | none | Associated accounts |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» contacts | [allOf] | false | none | List of contacts associated with this account |
post_api_account_create
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/account \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/account HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/account',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/account',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/account', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/account', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/account");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/account", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/account
Create a new account
Body parameter
{
"name": "string",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » name | body | string | false | The name of the account |
| » primaryEmail | body | string(email) | false | Primary email address |
| » secondaryEmail | body | string(email) | false | Secondary email address |
| » homePhone | body | string | false | Home phone number |
| » workPhone | body | string | false | Work phone number |
| » workPhoneExtension | body | string | false | Work phone extension |
| » mobilePhone | body | string | false | Mobile phone number |
| » address | body | string | false | Street address |
| » city | body | string | false | City |
| » province | body | string | false | Province/State |
| » postalCode | body | string | false | Postal/ZIP code |
| » country | body | string | false | Country |
| » language | body | string | false | Preferred language |
| » isActive | body | boolean | false | Whether the customer is active |
| » primaryContact | body | Contact | false | none |
| »» anonymous | body | BaseCustomer | false | none |
| »»» id | body | string(uuid) | false | The unique identifier (UUID7) |
| »»» primaryEmail | body | string(email) | false | Primary email address |
| »»» secondaryEmail | body | string(email) | false | Secondary email address |
| »»» homePhone | body | string | false | Home phone number |
| »»» workPhone | body | string | false | Work phone number |
| »»» workPhoneExtension | body | string | false | Work phone extension |
| »»» mobilePhone | body | string | false | Mobile phone number |
| »»» address | body | string | false | Street address |
| »»» city | body | string | false | City |
| »»» province | body | string | false | Province/State |
| »»» postalCode | body | string | false | Postal/ZIP code |
| »»» country | body | string | false | Country |
| »»» language | body | string | false | Preferred language |
| »»» isActive | body | boolean | false | Whether the customer is active |
| »»» thirdPartyIds | body | [allOf] | false | List of third party IDs associated with this customer |
| »»»» anonymous | body | BaseRecord | false | none |
| »»»»» anonymous | body | IdEntity | false | none |
| »»»»»» id | body | string(uuid) | false | The unique identifier (UUID7) |
| »»»»» anonymous | body | object | false | none |
| »»»»»» dateCreated | body | string(date-time) | false | Date when the record was created |
| »»»»»» createdBy | body | object | false | User who created the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» dateModified | body | string(date-time)¦null | false | Date when the record was last modified |
| »»»»»» modifiedBy | body | object | false | User who last modified the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» isDeleted | body | boolean | false | Whether the record has been deleted |
| »»»»»» dateDeleted | body | string(date-time)¦null | false | Date when the record was deleted |
| »»»»»» deletedBy | body | object | false | User who deleted the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» dtype | body | string | false | The discriminator type of the record |
| »»»» anonymous | body | object | false | none |
| »»»»» customer | body | object | false | The customer this third party ID belongs to |
| »»»»»» id | body | string(uuid) | false | The customer ID (UUID7) |
| »»»»» systemName | body | string | false | The name of the third party system |
| »»»»» thirdPartyId | body | string | false | The ID from the third party system |
| »»»»» metadata | body | string¦null | false | Additional metadata for the third party ID |
| »»»»» tenant | body | object | false | The tenant this third party ID belongs to |
| »»»»»» id | body | string(uuid) | false | The tenant ID (UUID7) |
| »» anonymous | body | object | false | none |
| »»» firstName | body | string | false | First name |
| »»» lastName | body | string | false | Last name |
| »»» companyName | body | string | false | Company name |
| »»» civility | body | string | false | Contact's civility |
| »»» preferredMethodOfContact | body | string | false | Preferred method of contact |
| »»» accounts | body | [allOf] | false | Associated accounts |
| »»»» anonymous | body | BaseCustomer | false | none |
| »»»» anonymous | body | object | false | none |
| »»»»» name | body | string | false | The name of the account |
| »»»»» primaryContact | body | Contact | false | none |
| »»»»» contacts | body | [allOf] | false | List of contacts associated with this account |
| » contacts | body | [allOf] | false | List of contacts associated with this account |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Account created successfully | Account |
| 400 | Bad Request | Invalid input data | None |
delete_api_account_deleteAccount
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/account/{account}
DELETE https://api.conecrm.com/api/account/{account} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/account/{account}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/account/{account}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/account/{account}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/account/{account}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/account/{account}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/account/{account}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/account/{account}
Delete an account
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| account | path | string(uuid) | true | Account ID (UUID7) |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Account deleted successfully | None |
patch_api_account_updateAccount
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/account/{account} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/account/{account} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/account/{account}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/account/{account}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/account/{account}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/account/{account}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/account/{account}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/account/{account}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/account/{account}
Update an existing account
Body parameter
{
"name": "string",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| account | path | string(uuid) | true | Account ID (UUID7) |
| body | body | object | true | none |
| » name | body | string | false | The name of the account |
| » primaryEmail | body | string(email) | false | Primary email address |
| » secondaryEmail | body | string(email) | false | Secondary email address |
| » homePhone | body | string | false | Home phone number |
| » workPhone | body | string | false | Work phone number |
| » workPhoneExtension | body | string | false | Work phone extension |
| » mobilePhone | body | string | false | Mobile phone number |
| » address | body | string | false | Street address |
| » city | body | string | false | City |
| » province | body | string | false | Province/State |
| » postalCode | body | string | false | Postal/ZIP code |
| » country | body | string | false | Country |
| » language | body | string | false | Preferred language |
| » isActive | body | boolean | false | Whether the customer is active |
| » primaryContact | body | Contact | false | none |
| »» anonymous | body | BaseCustomer | false | none |
| »»» id | body | string(uuid) | false | The unique identifier (UUID7) |
| »»» primaryEmail | body | string(email) | false | Primary email address |
| »»» secondaryEmail | body | string(email) | false | Secondary email address |
| »»» homePhone | body | string | false | Home phone number |
| »»» workPhone | body | string | false | Work phone number |
| »»» workPhoneExtension | body | string | false | Work phone extension |
| »»» mobilePhone | body | string | false | Mobile phone number |
| »»» address | body | string | false | Street address |
| »»» city | body | string | false | City |
| »»» province | body | string | false | Province/State |
| »»» postalCode | body | string | false | Postal/ZIP code |
| »»» country | body | string | false | Country |
| »»» language | body | string | false | Preferred language |
| »»» isActive | body | boolean | false | Whether the customer is active |
| »»» thirdPartyIds | body | [allOf] | false | List of third party IDs associated with this customer |
| »»»» anonymous | body | BaseRecord | false | none |
| »»»»» anonymous | body | IdEntity | false | none |
| »»»»»» id | body | string(uuid) | false | The unique identifier (UUID7) |
| »»»»» anonymous | body | object | false | none |
| »»»»»» dateCreated | body | string(date-time) | false | Date when the record was created |
| »»»»»» createdBy | body | object | false | User who created the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» dateModified | body | string(date-time)¦null | false | Date when the record was last modified |
| »»»»»» modifiedBy | body | object | false | User who last modified the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» isDeleted | body | boolean | false | Whether the record has been deleted |
| »»»»»» dateDeleted | body | string(date-time)¦null | false | Date when the record was deleted |
| »»»»»» deletedBy | body | object | false | User who deleted the record |
| »»»»»»» id | body | string(uuid) | false | The user ID (UUID7) |
| »»»»»» dtype | body | string | false | The discriminator type of the record |
| »»»» anonymous | body | object | false | none |
| »»»»» customer | body | object | false | The customer this third party ID belongs to |
| »»»»»» id | body | string(uuid) | false | The customer ID (UUID7) |
| »»»»» systemName | body | string | false | The name of the third party system |
| »»»»» thirdPartyId | body | string | false | The ID from the third party system |
| »»»»» metadata | body | string¦null | false | Additional metadata for the third party ID |
| »»»»» tenant | body | object | false | The tenant this third party ID belongs to |
| »»»»»» id | body | string(uuid) | false | The tenant ID (UUID7) |
| »» anonymous | body | object | false | none |
| »»» firstName | body | string | false | First name |
| »»» lastName | body | string | false | Last name |
| »»» companyName | body | string | false | Company name |
| »»» civility | body | string | false | Contact's civility |
| »»» preferredMethodOfContact | body | string | false | Preferred method of contact |
| »»» accounts | body | [allOf] | false | Associated accounts |
| »»»» anonymous | body | BaseCustomer | false | none |
| »»»» anonymous | body | object | false | none |
| »»»»» name | body | string | false | The name of the account |
| »»»»» primaryContact | body | Contact | false | none |
| »»»»» contacts | body | [allOf] | false | List of contacts associated with this account |
| » contacts | body | [allOf] | false | List of contacts associated with this account |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Account updated successfully | Account |
| 400 | Bad Request | Invalid input data | None |
Automations
get_api_automation_getBuilderData
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/automation/builder/data \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/automation/builder/data HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation/builder/data',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/automation/builder/data',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/automation/builder/data', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/automation/builder/data', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation/builder/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/automation/builder/data", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/automation/builder/data
Get automation builder data
Retrieves the metadata needed for the automation builder interface
Example responses
200 Response
{
"triggers": [
"string"
],
"actions": [
"string"
],
"conditions": [
"string"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the automation builder metadata | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » triggers | [string] | false | none | none |
| » actions | [string] | false | none | none |
| » conditions | [string] | false | none | none |
get_api_automation_getAutomations
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/automation \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/automation HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/automation',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/automation', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/automation', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/automation", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/automation
List automations
Retrieves a list of all automations
Example responses
200 Response
[
{}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of automations | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Automation2] | false | none | none |
post_api_automation_createAutomation
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/automation \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/automation HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/automation',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/automation', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/automation', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/automation", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/automation
Create a new automation
Creates a new automation workflow
Body parameter
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Automation3 | true | none |
Example responses
200 Response
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the created automation | Automation3 |
| 400 | Bad Request | Invalid input data | None |
get_api_automation_getAutomation
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/automation/{automation} \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/automation/{automation} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation/{automation}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/automation/{automation}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/automation/{automation}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/automation/{automation}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation/{automation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/automation/{automation}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/automation/{automation}
Get an automation
Retrieves a specific automation by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| automation | path | string | true | none |
Example responses
200 Response
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the automation | Automation3 |
| 404 | Not Found | Automation not found | None |
delete_api_automation_deleteAutomation
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/automation/{automation}
DELETE https://api.conecrm.com/api/automation/{automation} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/automation/{automation}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/automation/{automation}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/automation/{automation}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/automation/{automation}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation/{automation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/automation/{automation}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/automation/{automation}
Delete an automation
Deletes an existing automation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| automation | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Automation successfully deleted | None |
| 404 | Not Found | Automation not found | None |
patch_api_automation_updateAutomation
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/automation/{automation} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/automation/{automation} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation/{automation}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/automation/{automation}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/automation/{automation}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/automation/{automation}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation/{automation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/automation/{automation}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/automation/{automation}
Update an automation
Updates an existing automation workflow
Body parameter
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| automation | path | string | true | none |
| body | body | Automation3 | true | none |
Example responses
200 Response
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the updated automation | Automation3 |
| 400 | Bad Request | Invalid input data | None |
| 404 | Not Found | Automation not found | None |
post_api_automation_duplicateAutomation
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/automation/{automation}/duplicate \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/automation/{automation}/duplicate HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/automation/{automation}/duplicate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/automation/{automation}/duplicate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/automation/{automation}/duplicate', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/automation/{automation}/duplicate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/automation/{automation}/duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/automation/{automation}/duplicate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/automation/{automation}/duplicate
Duplicate an automation
Creates a copy of an existing automation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| automation | path | string | true | none |
Example responses
200 Response
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the duplicated automation | Automation3 |
| 404 | Not Found | Automation not found | None |
Contact
_getContacts
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/contact \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/contact HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/contact',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/contact',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/contact', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/contact', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/contact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/contact", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/contact
Get Contacts
Get Contacts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| start | query | integer(int64) | false | Start index |
| limit | query | integer(int64) | false | Maximum limit of Contacts to return |
| search | query | string | false | Search string |
| exclude | query | string | false | Exclude Contact ID |
| franchise | query | integer(int64) | false | Search with franchise ID |
| sortField | query | string | false | Field to sort by (e.g. firstName, lastName, dateCreated) |
| sortDirection | query | string | false | Sort direction (ASC or DESC) |
Enumerated Values
| Parameter | Value |
|---|---|
| sortDirection | ASC |
| sortDirection | DESC |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | BaseCustomer | false | none | none |
| »» id | string(uuid) | false | none | The unique identifier (UUID7) |
| »» primaryEmail | string(email) | false | none | Primary email address |
| »» secondaryEmail | string(email) | false | none | Secondary email address |
| »» homePhone | string | false | none | Home phone number |
| »» workPhone | string | false | none | Work phone number |
| »» workPhoneExtension | string | false | none | Work phone extension |
| »» mobilePhone | string | false | none | Mobile phone number |
| »» address | string | false | none | Street address |
| »» city | string | false | none | City |
| »» province | string | false | none | Province/State |
| »» postalCode | string | false | none | Postal/ZIP code |
| »» country | string | false | none | Country |
| »» language | string | false | none | Preferred language |
| »» isActive | boolean | false | none | Whether the customer is active |
| »» thirdPartyIds | [allOf] | false | none | List of third party IDs associated with this customer |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | BaseRecord | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | IdEntity | false | none | none |
| »»»»» id | string(uuid) | false | none | The unique identifier (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | object | false | none | none |
| »»»»» dateCreated | string(date-time) | false | none | Date when the record was created |
| »»»»» createdBy | object | false | none | User who created the record |
| »»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»» dateModified | string(date-time)¦null | false | none | Date when the record was last modified |
| »»»»» modifiedBy | object | false | none | User who last modified the record |
| »»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»» isDeleted | boolean | false | none | Whether the record has been deleted |
| »»»»» dateDeleted | string(date-time)¦null | false | none | Date when the record was deleted |
| »»»»» deletedBy | object | false | none | User who deleted the record |
| »»»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»»» dtype | string | false | none | The discriminator type of the record |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | object | false | none | none |
| »»»» customer | object | false | none | The customer this third party ID belongs to |
| »»»»» id | string(uuid) | false | none | The customer ID (UUID7) |
| »»»» systemName | string | false | none | The name of the third party system |
| »»»» thirdPartyId | string | false | none | The ID from the third party system |
| »»»» metadata | string¦null | false | none | Additional metadata for the third party ID |
| »»»» tenant | object | false | none | The tenant this third party ID belongs to |
| »»»»» id | string(uuid) | false | none | The tenant ID (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | none |
| »» firstName | string | false | none | First name |
| »» lastName | string | false | none | Last name |
| »» companyName | string | false | none | Company name |
| »» civility | string | false | none | Contact's civility |
| »» preferredMethodOfContact | string | false | none | Preferred method of contact |
| »» accounts | [allOf] | false | none | Associated accounts |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | BaseCustomer | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | object | false | none | none |
| »»»» name | string | false | none | The name of the account |
| »»»» primaryContact | Contact | false | none | none |
| »»»» contacts | [allOf] | false | none | List of contacts associated with this account |
_get_contact_open_leads
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/contact/{contact}/lead/open \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/contact/{contact}/lead/open HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/contact/{contact}/lead/open',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/contact/{contact}/lead/open',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/contact/{contact}/lead/open', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/contact/{contact}/lead/open', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/contact/{contact}/lead/open");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/contact/{contact}/lead/open", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/contact/{contact}/lead/open
Get Contact Open Leads
Get Contact Open Leads
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| contact | path | integer(int64) | true | Contact ID |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
],
"category": "CAR",
"automationDay": 0,
"visitCount": 0,
"isTakeOver": false,
"isWalkAroundDone": false,
"walkAroundDate": "2019-08-24T14:15:22Z",
"takeOverDate": "2019-08-24T14:15:22Z",
"offerMade": true,
"offerMadeDate": "2019-08-24T14:15:22Z",
"soldDate": "2019-08-24T14:15:22Z",
"soldBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"presaleVisitCount": 0,
"postsaleVisitCount": 0,
"customerInitiated": true,
"inTransit": true,
"cpo": true,
"demo": true,
"formName": "string",
"leadHandlingInstructions": "string",
"creditAssessments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"incentives": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"packages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"surveys": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | Connection | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | BaseRecord | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | IdEntity | false | none | none |
| »»»» id | string(uuid) | false | none | The unique identifier (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | object | false | none | none |
| »»»» dateCreated | string(date-time) | false | none | Date when the record was created |
| »»»» createdBy | object | false | none | User who created the record |
| »»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»» dateModified | string(date-time)¦null | false | none | Date when the record was last modified |
| »»»» modifiedBy | object | false | none | User who last modified the record |
| »»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»» isDeleted | boolean | false | none | Whether the record has been deleted |
| »»»» dateDeleted | string(date-time)¦null | false | none | Date when the record was deleted |
| »»»» deletedBy | object | false | none | User who deleted the record |
| »»»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»»» dtype | string | false | none | The discriminator type of the record |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» subject | string | false | none | The subject of the connection |
| »»» description | string¦null | false | none | Detailed description of the connection |
| »»» status | object | false | none | The status of the connection |
| »»»» id | string(uuid) | false | none | The status ID (UUID7) |
| »»» dateFirstModified | string(date-time)¦null | false | none | Date when the connection was first modified |
| »»» firstModifiedBy | object | false | none | User who first modified the connection |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» source | object | false | none | The source of the connection |
| »»»» id | string(uuid) | false | none | The source ID (UUID7) |
| »»» contact | object | false | none | The contact associated with this connection |
| »»»» id | string(uuid) | false | none | The contact ID (UUID7) |
| »»» account | object | false | none | The account associated with this connection |
| »»»» id | string(uuid) | false | none | The account ID (UUID7) |
| »»» franchise | object | false | none | The franchise associated with this connection |
| »»»» id | string(uuid) | false | none | The franchise ID (UUID7) |
| »»» dueDate | string(date-time)¦null | false | none | Due date for the connection |
| »»» stage | object | false | none | The stage of the connection |
| »»»» id | string(uuid) | false | none | The stage ID (UUID7) |
| »»» direction | string | false | none | The direction of the connection |
| »»» isQualified | boolean | false | none | Whether the connection is qualified |
| »»» connectionClosedDate | string(date-time)¦null | false | none | Date when the connection was closed |
| »»» connectionClosedBy | object | false | none | User who closed the connection |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» expectedDeliveryDate | string(date-time)¦null | false | none | Expected delivery date |
| »»» isLostApproved | boolean¦null | false | none | Whether the loss has been approved |
| »»» lostBy | object | false | none | User who marked the connection as lost |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» lostDate | string(date-time)¦null | false | none | Date when the connection was marked as lost |
| »»» firstOpenDate | string(date-time)¦null | false | none | Date when the connection was first opened |
| »»» firstOpenBy | object | false | none | User who first opened the connection |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» testDriveDone | boolean¦null | false | none | Whether a test drive has been done |
| »»» testDriveDate | string(date-time)¦null | false | none | Date when the test drive was done |
| »»» orderPlaced | boolean¦null | false | none | Whether an order has been placed |
| »»» orderDate | string(date-time)¦null | false | none | Date when the order was placed |
| »»» tradeInAppraisalDone | boolean¦null | false | none | Whether a trade-in appraisal has been done |
| »»» tradeInAppraisalDate | string(date-time)¦null | false | none | Date when the trade-in appraisal was done |
| »»» creditApplicationSubmitted | boolean¦null | false | none | Whether a credit application has been submitted |
| »»» creditApplicationSubmittedDate | string(date-time)¦null | false | none | Date when the credit application was submitted |
| »»» priority | integer¦null | false | none | Priority level of the connection |
| »»» thirdPartyIds | [allOf] | false | none | List of third party IDs associated with this connection |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | object | false | none | none |
| »»»»»» systemName | string | false | none | The system name |
| »»»»»» thirdPartyId | string | false | none | The third party ID |
| »»»»»» metadata | string¦null | false | none | The metadata |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | object | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | none |
| »» category | string¦null | false | none | The category of the lead |
| »» automationDay | integer¦null | false | none | The automation day for the lead |
| »» visitCount | integer | false | none | Number of visits for this lead |
| »» isTakeOver | boolean | false | none | Whether the lead has been taken over |
| »» isWalkAroundDone | boolean | false | none | Whether the walk around has been completed |
| »» walkAroundDate | string(date-time)¦null | false | none | Date when the walk around was completed |
| »» takeOverDate | string(date-time)¦null | false | none | Date when the lead was taken over |
| »» offerMade | boolean¦null | false | none | Whether an offer has been made |
| »» offerMadeDate | string(date-time)¦null | false | none | Date when the offer was made |
| »» soldDate | string(date-time)¦null | false | none | Date when the lead was sold |
| »» soldBy | object | false | none | The user who sold the lead |
| »»» id | string(uuid) | false | none | The user ID (UUID7) |
| »» presaleVisitCount | integer | false | none | Number of pre-sale visits |
| »» postsaleVisitCount | integer | false | none | Number of post-sale visits |
| »» customerInitiated | boolean | false | none | Whether the lead was initiated by the customer |
| »» inTransit | boolean¦null | false | none | Whether the lead is in transit |
| »» cpo | boolean¦null | false | none | Whether the lead is a CPO (Certified Pre-Owned) |
| »» demo | boolean¦null | false | none | Whether the lead is for a demo |
| »» formName | string¦null | false | none | Name of the form used to capture the lead |
| »» leadHandlingInstructions | string¦null | false | none | Instructions for handling the lead |
| »» creditAssessments | [object] | false | none | List of credit assessments for this lead |
| »»» id | string(uuid) | false | none | The credit assessment ID (UUID7) |
| »» incentives | [object] | false | none | List of incentives for this lead |
| »»» id | string(uuid) | false | none | The incentive ID (UUID7) |
| »» packages | [object] | false | none | List of packages for this lead |
| »»» id | string(uuid) | false | none | The package ID (UUID7) |
| »» surveys | [object] | false | none | List of surveys for this lead |
| »»» id | string(uuid) | false | none | The survey ID (UUID7) |
get_contact_findByPhone
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/contact/phone/{phone}
GET https://api.conecrm.com/api/contact/phone/{phone} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/contact/phone/{phone}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.get 'https://api.conecrm.com/api/contact/phone/{phone}',
params: {
}
p JSON.parse(result)
import requests
r = requests.get('https://api.conecrm.com/api/contact/phone/{phone}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/contact/phone/{phone}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/contact/phone/{phone}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/contact/phone/{phone}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/contact/phone/{phone}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| phone | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| default | Default | none | None |
CustomField
get_api_custom_field_getCustomFields
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/custom-field \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/custom-field HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-field',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/custom-field',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/custom-field', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/custom-field', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-field");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/custom-field", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/custom-field
Retrieve all custom fields
Example responses
200 Response
[
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved custom fields | Inline |
| 400 | Bad Request | Bad request | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CustomField] | false | none | none |
| » entity | string | false | none | The entity the custom field belongs to |
| » fieldName | string | false | none | The name of the custom field |
| » fieldType | string | false | none | The type of the custom field |
| » options | string | false | none | The options of the custom field (json encoded object) |
post_api_custom_field_createCustomField
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/custom-field \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/custom-field HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-field',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/custom-field',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/custom-field', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/custom-field', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-field");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/custom-field", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/custom-field
Create a new custom field
Body parameter
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CustomField | false | none |
Example responses
200 Response
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully created custom field | CustomField |
| 400 | Bad Request | Bad request | None |
get_api_custom_field_getCustomFieldsForEntity
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/custom-field/{entity}
GET https://api.conecrm.com/api/custom-field/{entity} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/custom-field/{entity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.get 'https://api.conecrm.com/api/custom-field/{entity}',
params: {
}
p JSON.parse(result)
import requests
r = requests.get('https://api.conecrm.com/api/custom-field/{entity}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/custom-field/{entity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-field/{entity}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/custom-field/{entity}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/custom-field/{entity}
Retrieve all custom fields for an entity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved custom fields for an entity | None |
| 400 | Bad Request | Bad request | None |
delete_api_custom_field_deleteCustomField
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/custom-field/{customField}
DELETE https://api.conecrm.com/api/custom-field/{customField} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/custom-field/{customField}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/custom-field/{customField}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/custom-field/{customField}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/custom-field/{customField}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-field/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/custom-field/{customField}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/custom-field/{customField}
Delete a custom field
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customField | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully deleted custom field | None |
| 400 | Bad Request | Bad request | None |
patch_api_custom_field_updateCustomField
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/custom-field/{customField} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/custom-field/{customField} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-field/{customField}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/custom-field/{customField}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/custom-field/{customField}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/custom-field/{customField}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-field/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/custom-field/{customField}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/custom-field/{customField}
Update a custom field
Body parameter
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customField | path | string | true | none |
| body | body | CustomField | false | none |
Example responses
200 Response
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully updated custom field | CustomField |
| 400 | Bad Request | Bad request | None |
CustomLabel
get_custom_label_list
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/custom-labels \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/custom-labels HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-labels',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/custom-labels',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/custom-labels', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/custom-labels', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/custom-labels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/custom-labels
List all custom labels
Retrieve all custom labels for the current tenant
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of custom labels | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | BaseRecord | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | IdEntity | false | none | none |
| »»» id | string(uuid) | false | none | The unique identifier (UUID7) |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» dateCreated | string(date-time) | false | none | Date when the record was created |
| »»» createdBy | object | false | none | User who created the record |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» dateModified | string(date-time)¦null | false | none | Date when the record was last modified |
| »»» modifiedBy | object | false | none | User who last modified the record |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» isDeleted | boolean | false | none | Whether the record has been deleted |
| »»» dateDeleted | string(date-time)¦null | false | none | Date when the record was deleted |
| »»» deletedBy | object | false | none | User who deleted the record |
| »»»» id | string(uuid) | false | none | The user ID (UUID7) |
| »»» dtype | string | false | none | The discriminator type of the record |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | none |
| »» tenant | object | false | none | The tenant this custom label belongs to |
| »»» id | string(uuid) | false | none | The tenant ID (UUID7) |
| »»» name | string | false | none | The name of the tenant |
| »» value | object | false | none | The custom label values as a JSON object |
post_custom_label_create
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/custom-labels \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/custom-labels HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-labels',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/custom-labels',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/custom-labels', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/custom-labels', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/custom-labels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/custom-labels
Create a new custom label
Create a new custom label with the provided value
Body parameter
{
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » value | body | object | true | The custom label values as a JSON object |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom label created successfully | CustomLabel |
| 400 | Bad Request | Bad request - value is required | Inline |
Response Schema
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
delete_custom_label_delete
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/custom-labels/{id} \
-H 'Accept: application/json'
DELETE https://api.conecrm.com/api/custom-labels/{id} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-labels/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.conecrm.com/api/custom-labels/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://api.conecrm.com/api/custom-labels/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/custom-labels/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-labels/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/custom-labels/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/custom-labels/{id}
Delete a custom label
Soft delete a custom label by setting isDeleted to true
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | The ID of the custom label to delete |
Example responses
200 Response
null
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom label deleted successfully | null |
| 404 | Not Found | Custom label not found | None |
patch_custom_label_update
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/custom-labels/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/custom-labels/{id} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"value": {
"label1": "Updated Label 1",
"label2": "Updated Label 2"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/custom-labels/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/custom-labels/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/custom-labels/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/custom-labels/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/custom-labels/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/custom-labels/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/custom-labels/{id}
Update a custom label
Update an existing custom label with new values
Body parameter
{
"value": {
"label1": "Updated Label 1",
"label2": "Updated Label 2"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | The ID of the custom label to update |
| body | body | object | true | none |
| » value | body | object | true | The updated custom label values as a JSON object |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom label updated successfully | CustomLabel |
| 400 | Bad Request | Bad request - value is required | Inline |
| 404 | Not Found | Custom label not found | None |
Response Schema
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
Filters
get_api_filtersget_all_filters
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/filters \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/filters HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/filters',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/filters',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/filters', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/filters', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/filters");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/filters", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/filters
Get all available filters
Retrieves filters for all entities that have defined filter attributes
Example responses
200 Response
{
"data": [
{
"entity": "string",
"filters": [
null
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of all available filters | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » data | [EntityFilters2] | false | none | none |
| »» entity | string | true | none | none |
| »» filters | [any] | true | none | none |
get_api_filtersget_entity_filters
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/filters/{entity} \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/filters/{entity} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/filters/{entity}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/filters/{entity}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/filters/{entity}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/filters/{entity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/filters/{entity}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/filters/{entity}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/filters/{entity}
Get filters for a specific entity
Retrieves available filters for a specific entity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entity | path | string | true | The entity name to get filters for |
Example responses
200 Response
[
{
"field": "string",
"type": "string",
"label": "string",
"operators": [
null
],
"options": null
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of filters for the specified entity | Inline |
| 404 | Not Found | Entity not found or no filters available | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Filter2] | false | none | none |
| » field | string | true | none | none |
| » type | string | true | none | none |
| » label | string | true | none | none |
| » operators | [any] | true | none | none |
| » options | [any]¦null | false | none | none |
Status Code 404
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
Lead
post_lead_createLead
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/lead \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/lead HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"subject": "string",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"makeStr": "string",
"modelStr": "string",
"yearStr": "stri",
"trimStr": "string",
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"assignees": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"description": "string",
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"category": "CAR",
"utmCampaign": "string",
"utmSource": "string",
"customerInitiated": true,
"leadHandlingInstructions": "string",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"customFieldValues": [
{
"field": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"value": "string"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/lead',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/lead',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/lead', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/lead', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/lead");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/lead", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/lead
Create a new lead
Creates a new lead with the provided information. The lead will be automatically assigned and processed according to the system workflow.
Body parameter
{
"subject": "string",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"makeStr": "string",
"modelStr": "string",
"yearStr": "stri",
"trimStr": "string",
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"assignees": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"description": "string",
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"category": "CAR",
"utmCampaign": "string",
"utmSource": "string",
"customerInitiated": true,
"leadHandlingInstructions": "string",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"customFieldValues": [
{
"field": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"value": "string"
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | LeadCreateRequest | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
],
"category": "CAR",
"automationDay": 0,
"visitCount": 0,
"isTakeOver": false,
"isWalkAroundDone": false,
"walkAroundDate": "2019-08-24T14:15:22Z",
"takeOverDate": "2019-08-24T14:15:22Z",
"offerMade": true,
"offerMadeDate": "2019-08-24T14:15:22Z",
"soldDate": "2019-08-24T14:15:22Z",
"soldBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"presaleVisitCount": 0,
"postsaleVisitCount": 0,
"customerInitiated": true,
"inTransit": true,
"cpo": true,
"demo": true,
"formName": "string",
"leadHandlingInstructions": "string",
"creditAssessments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"incentives": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"packages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"surveys": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Lead created successfully | Lead |
| 400 | Bad Request | Invalid data provided or form validation failed | Inline |
| 401 | Unauthorized | User not authenticated | None |
| 403 | Forbidden | User not authorized to create leads | None |
Response Schema
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » errors | object | false | none | Form validation errors |
| » message | string | false | none | Error message |
post_lead_copy_lead
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/lead/{lead}/copy \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/lead/{lead}/copy HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"subject": "New Lead Copy",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sales New",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
},
"pipeline": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/lead/{lead}/copy',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/lead/{lead}/copy',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/lead/{lead}/copy', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/lead/{lead}/copy', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/lead/{lead}/copy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/lead/{lead}/copy", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/lead/{lead}/copy
Copy a lead
Creates a copy of an existing lead with new contact, account, and optional parameters. The copied lead will inherit most properties from the original lead but can have different contact, account, subject, department, and franchise.
Body parameter
{
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"subject": "New Lead Copy",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sales New",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
},
"pipeline": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| lead | path | string | true | none |
| body | body | CopyLeadData | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
],
"category": "CAR",
"automationDay": 0,
"visitCount": 0,
"isTakeOver": false,
"isWalkAroundDone": false,
"walkAroundDate": "2019-08-24T14:15:22Z",
"takeOverDate": "2019-08-24T14:15:22Z",
"offerMade": true,
"offerMadeDate": "2019-08-24T14:15:22Z",
"soldDate": "2019-08-24T14:15:22Z",
"soldBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"presaleVisitCount": 0,
"postsaleVisitCount": 0,
"customerInitiated": true,
"inTransit": true,
"cpo": true,
"demo": true,
"formName": "string",
"leadHandlingInstructions": "string",
"creditAssessments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"incentives": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"packages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"surveys": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Lead copied successfully | Lead |
| 400 | Bad Request | Invalid data provided or form validation failed | Inline |
| 401 | Unauthorized | User not authenticated | None |
| 403 | Forbidden | User not authorized to copy leads | None |
| 404 | Not Found | Lead not found | None |
Response Schema
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » errors | object | false | none | Form validation errors |
| » message | string | false | none | Error message |
QueryBuilder
get_api_query_builder_config
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/query-builder/config/{entity} \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/query-builder/config/{entity} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/query-builder/config/{entity}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/query-builder/config/{entity}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/query-builder/config/{entity}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/query-builder/config/{entity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/query-builder/config/{entity}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/query-builder/config/{entity}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/query-builder/config/{entity}
Get QueryBuilder configuration for an entity
Retrieves the configuration needed to build a query for a specific entity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entity | path | string | true | The name of the entity to get configuration for |
Example responses
200 Response
{
"fields": [
{}
],
"operators": [
"string"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Configuration retrieved successfully | Inline |
| 404 | Not Found | Entity not found | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » fields | [object] | false | none | none |
| » operators | [string] | false | none | none |
Status Code 404
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
post_api_query_builder_filter
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/query-builder/filter/{entity} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/query-builder/filter/{entity} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"query": {
"id": "293934ac-c55a-4a69-b61c-aa6d16831bc5",
"combinator": "or",
"rules": [
{
"id": "7a1208e9-f165-4835-903d-4fd4639db151",
"field": "primaryEmail",
"operator": "endsWith",
"valueSource": "value",
"value": ".com"
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/query-builder/filter/{entity}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/query-builder/filter/{entity}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/query-builder/filter/{entity}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/query-builder/filter/{entity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/query-builder/filter/{entity}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/query-builder/filter/{entity}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/query-builder/filter/{entity}
Apply filters to an entity
Applies the provided query builder filters to the specified entity. The query can contain nested rule groups and various operators for complex filtering.
Body parameter
{
"query": {
"id": "293934ac-c55a-4a69-b61c-aa6d16831bc5",
"combinator": "or",
"rules": [
{
"id": "7a1208e9-f165-4835-903d-4fd4639db151",
"field": "primaryEmail",
"operator": "endsWith",
"valueSource": "value",
"value": ".com"
}
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entity | path | string | true | The name of the entity to filter |
| body | body | QueryBuilderQuery | true | none |
Example responses
200 Response
{
"success": true,
"data": [
{}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Filters applied successfully | Inline |
| 400 | Bad Request | Invalid request | Inline |
| 404 | Not Found | Entity not found | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » success | boolean | false | none | none |
| » data | [object] | false | none | none |
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
Status Code 404
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
SavedFilter
get_savedFilterlist
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/saved-filter \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/saved-filter HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/saved-filter',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/saved-filter',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/saved-filter', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/saved-filter', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/saved-filter");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/saved-filter", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/saved-filter
List saved filters
Get a list of all saved filters for the current user
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"module": "string",
"value": "string",
"owner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"private": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of saved filters | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SavedFilter] | false | none | none |
| » id | string(uuid) | false | none | The unique identifier of the saved filter (UUID7) |
| » name | string | false | none | The name of the saved filter |
| » module | string | false | none | The module this filter belongs to |
| » value | string | false | none | The filter configuration value as a json encoded object |
| » owner | object | false | none | The user who owns this filter |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » private | boolean | false | none | Whether the filter is private or shared |
post_savedFiltercreate
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/saved-filter \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/saved-filter HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"module": "string",
"value": "string",
"private": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/saved-filter',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/saved-filter',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/saved-filter', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/saved-filter', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/saved-filter");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/saved-filter", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/saved-filter
Create a saved filter
Create a new saved filter for the current user
Body parameter
{
"name": "string",
"module": "string",
"value": "string",
"private": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » name | body | string | true | none |
| » module | body | string | true | none |
| » value | body | string | true | none |
| » private | body | boolean | false | none |
Example responses
201 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"module": "string",
"value": "string",
"owner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"private": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Saved filter created successfully | SavedFilter |
| 400 | Bad Request | Invalid data provided | None |
get_savedFilterread
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/saved-filter/{id} \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/saved-filter/{id} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/saved-filter/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/saved-filter/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/saved-filter/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/saved-filter/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/saved-filter/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/saved-filter/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/saved-filter/{id}
Get a saved filter
Get details of a specific saved filter
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | The saved filter ID |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"module": "string",
"value": "string",
"owner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"private": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Saved filter details | SavedFilter |
| 403 | Forbidden | Access denied | None |
| 404 | Not Found | Saved filter not found | None |
delete_savedFilterdelete
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/saved-filter/{filter}
DELETE https://api.conecrm.com/api/saved-filter/{filter} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/saved-filter/{filter}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/saved-filter/{filter}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/saved-filter/{filter}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/saved-filter/{filter}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/saved-filter/{filter}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/saved-filter/{filter}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/saved-filter/{filter}
Delete a saved filter
Delete an existing saved filter
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | The saved filter ID |
| filter | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Saved filter deleted successfully | None |
| 403 | Forbidden | Access denied | None |
| 404 | Not Found | Saved filter not found | None |
patch_savedFilterupdate
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/saved-filter/{filter} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/saved-filter/{filter} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"module": "string",
"value": "string",
"private": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/saved-filter/{filter}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/saved-filter/{filter}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/saved-filter/{filter}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/saved-filter/{filter}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/saved-filter/{filter}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/saved-filter/{filter}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/saved-filter/{filter}
Update a saved filter
Update an existing saved filter
Body parameter
{
"name": "string",
"module": "string",
"value": "string",
"private": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | The saved filter ID |
| filter | path | string | true | none |
| body | body | object | true | none |
| » name | body | string | false | none |
| » module | body | string | false | none |
| » value | body | string | false | none |
| » private | body | boolean | false | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"module": "string",
"value": "string",
"owner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"private": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Saved filter updated successfully | SavedFilter |
| 400 | Bad Request | Invalid data provided | None |
| 403 | Forbidden | Access denied | None |
| 404 | Not Found | Saved filter not found | None |
Stage
get_api_stage_list
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/stage \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/stage HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/stage',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/stage',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/stage', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/stage', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/stage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/stage", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/stage
List all stages
Retrieve a list of all connection stages
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of stages | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ConnectionStage] | false | none | none |
| » id | string(uuid) | false | none | The unique identifier of the stage (UUID7) |
| » name | string | false | none | The name of the stage |
post_api_stage_create
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/stage \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/stage HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/stage',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/stage',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/stage', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/stage', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/stage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/stage", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/stage
Create a stage
Create a new connection stage
Body parameter
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ConnectionStage | true | none |
Example responses
201 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Stage created successfully | ConnectionStage |
| 400 | Bad Request | Invalid input | None |
get_api_stage_get
Code samples
# You can also use wget
curl -X GET https://api.conecrm.com/api/stage/{id} \
-H 'Accept: application/json'
GET https://api.conecrm.com/api/stage/{id} HTTP/1.1
Host: api.conecrm.com
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/stage/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.conecrm.com/api/stage/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.conecrm.com/api/stage/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.conecrm.com/api/stage/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/stage/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.conecrm.com/api/stage/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/stage/{id}
Get a stage
Retrieve a specific connection stage by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The stage | ConnectionStage |
| 404 | Not Found | Stage not found | None |
delete_api_stage_delete
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/stage/{id}
DELETE https://api.conecrm.com/api/stage/{id} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/stage/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/stage/{id}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/stage/{id}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/stage/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/stage/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/stage/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/stage/{id}
Delete a stage
Delete a connection stage. Cannot delete if used in connections or pipelines.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Stage deleted successfully | None |
| 400 | Bad Request | Cannot delete stage that is used in connections or pipelines | None |
| 404 | Not Found | Stage not found | None |
patch_api_stage_update
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/stage/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/stage/{id} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/stage/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/stage/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/stage/{id}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/stage/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/stage/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/stage/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/stage/{id}
Update a stage
Update an existing connection stage
Body parameter
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| body | body | ConnectionStage | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Stage updated successfully | ConnectionStage |
| 400 | Bad Request | Invalid input | None |
| 404 | Not Found | Stage not found | None |
Tasks
post_api_task_create
Code samples
# You can also use wget
curl -X POST https://api.conecrm.com/api/task \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.conecrm.com/api/task HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"type": "CALL",
"assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
"connection": "05107f3a-70a0-49c6-879b-3a441d6562d4"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/task',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.conecrm.com/api/task',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.conecrm.com/api/task', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.conecrm.com/api/task', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/task");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.conecrm.com/api/task", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/task
Create a new task
Body parameter
{
"type": "CALL",
"assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
"connection": "05107f3a-70a0-49c6-879b-3a441d6562d4"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | TaskRequest | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"type": "string"
}
400 Response
"title This value should not be blank."
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Task created successfully | Task |
| 400 | Bad Request | Invalid input data or validation errors | string |
delete_api_task_deleteTask
Code samples
# You can also use wget
curl -X DELETE https://api.conecrm.com/api/task/{task}
DELETE https://api.conecrm.com/api/task/{task} HTTP/1.1
Host: api.conecrm.com
fetch('https://api.conecrm.com/api/task/{task}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.conecrm.com/api/task/{task}',
params: {
}
p JSON.parse(result)
import requests
r = requests.delete('https://api.conecrm.com/api/task/{task}')
print(r.json())
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.conecrm.com/api/task/{task}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/task/{task}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.conecrm.com/api/task/{task}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/task/{task}
Delete a task
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| task | path | string(uuid) | true | The task ID |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Task deleted successfully | None |
| 403 | Forbidden | Not authorized to delete this task | None |
| 404 | Not Found | Task not found | None |
patch_api_task_updateTask
Code samples
# You can also use wget
curl -X PATCH https://api.conecrm.com/api/task/{task} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH https://api.conecrm.com/api/task/{task} HTTP/1.1
Host: api.conecrm.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"type": "CALL",
"assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
"connection": "05107f3a-70a0-49c6-879b-3a441d6562d4"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.conecrm.com/api/task/{task}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.patch 'https://api.conecrm.com/api/task/{task}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('https://api.conecrm.com/api/task/{task}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.conecrm.com/api/task/{task}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://api.conecrm.com/api/task/{task}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.conecrm.com/api/task/{task}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PATCH /api/task/{task}
Update an existing task
Body parameter
{
"type": "CALL",
"assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
"connection": "05107f3a-70a0-49c6-879b-3a441d6562d4"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| task | path | string(uuid) | true | The task ID |
| body | body | TaskRequest | true | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"type": "string"
}
400 Response
"title This value should not be blank."
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Task updated successfully | Task |
| 400 | Bad Request | Invalid input data or validation errors | string |
| 403 | Forbidden | Not authorized to edit this task | None |
| 404 | Not Found | Task not found | None |
Schemas
ConnectionStage
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier of the stage (UUID7) |
| name | string | false | none | The name of the stage |
CustomField
{
"entity": "string",
"fieldName": "string",
"fieldType": "string",
"options": "{\"min\": 1, \"max\": 10}"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entity | string | false | none | The entity the custom field belongs to |
| fieldName | string | false | none | The name of the custom field |
| fieldType | string | false | none | The type of the custom field |
| options | string | false | none | The options of the custom field (json encoded object) |
CustomLabel
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » tenant | object | false | none | The tenant this custom label belongs to |
| »» id | string(uuid) | false | none | The tenant ID (UUID7) |
| »» name | string | false | none | The name of the tenant |
| » value | object | false | none | The custom label values as a JSON object |
Tenant
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | IdEntity | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the tenant |
| » vertical | string | false | none | The vertical market for this tenant |
| » franchises | [object] | false | none | The franchises of the tenant |
| »» id | string(uuid) | false | none | The franchise ID (UUID7) |
| » users | [object] | false | none | The users associated with this tenant |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » customLabels | [CustomLabel] | false | none | The custom labels for this tenant |
QueryBuilderRule
{
"id": "7a1208e9-f165-4835-903d-4fd4639db151",
"field": "primaryEmail",
"operator": "endsWith",
"valueSource": "value",
"value": ".com"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Unique identifier for the rule |
| field | string | false | none | The field to filter on |
| operator | string | false | none | The operator to use for comparison |
| valueSource | string | false | none | The source of the value |
| value | string | false | none | The value to compare against |
Enumerated Values
| Property | Value |
|---|---|
| operator | = |
| operator | != |
| operator | > |
| operator | >= |
| operator | < |
| operator | <= |
| operator | contains |
| operator | doesNotContain |
| operator | beginsWith |
| operator | doesNotBeginWith |
| operator | endsWith |
| operator | doesNotEndWith |
| operator | null |
| operator | notNull |
| operator | in |
| operator | notIn |
| operator | between |
| operator | notBetween |
QueryBuilderRuleGroup
{
"id": "276ca16c-4c77-47c9-82ec-9ec2fe5af4f2",
"combinator": "or",
"not": false,
"rules": [
{
"id": "7a1208e9-f165-4835-903d-4fd4639db151",
"field": "primaryEmail",
"operator": "endsWith",
"valueSource": "value",
"value": ".com"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Unique identifier for the rule group |
| combinator | string | false | none | How to combine the rules in this group |
| not | boolean | false | none | Whether to negate the entire group |
| rules | [oneOf] | false | none | Array of rules and rule groups |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | QueryBuilderRule | false | none | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | QueryBuilderRuleGroup | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| combinator | and |
| combinator | or |
QueryBuilderQuery
{
"query": {
"id": "293934ac-c55a-4a69-b61c-aa6d16831bc5",
"combinator": "or",
"rules": [
{
"id": "7a1208e9-f165-4835-903d-4fd4639db151",
"field": "primaryEmail",
"operator": "endsWith",
"valueSource": "value",
"value": ".com"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| query | object | false | none | none |
| » id | string | false | none | Unique identifier for the query |
| » combinator | string | false | none | How to combine the rules |
| » rules | [oneOf] | false | none | Array of rules and rule groups |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | QueryBuilderRule | false | none | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | QueryBuilderRuleGroup | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| combinator | and |
| combinator | or |
SavedFilter
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"module": "string",
"value": "string",
"owner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"private": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier of the saved filter (UUID7) |
| name | string | false | none | The name of the saved filter |
| module | string | false | none | The module this filter belongs to |
| value | string | false | none | The filter configuration value as a json encoded object |
| owner | object | false | none | The user who owns this filter |
| » id | string(uuid) | false | none | The user ID (UUID7) |
| private | boolean | false | none | Whether the filter is private or shared |
Account
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseCustomer | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the account |
| » primaryContact | Contact | false | none | none |
| » contacts | [Contact] | false | none | List of contacts associated with this account |
BaseCustomer
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier (UUID7) |
| primaryEmail | string(email) | false | none | Primary email address |
| secondaryEmail | string(email) | false | none | Secondary email address |
| homePhone | string | false | none | Home phone number |
| workPhone | string | false | none | Work phone number |
| workPhoneExtension | string | false | none | Work phone extension |
| mobilePhone | string | false | none | Mobile phone number |
| address | string | false | none | Street address |
| city | string | false | none | City |
| province | string | false | none | Province/State |
| postalCode | string | false | none | Postal/ZIP code |
| country | string | false | none | Country |
| language | string | false | none | Preferred language |
| isActive | boolean | false | none | Whether the customer is active |
| thirdPartyIds | [BaseCustomerThirdPartyId] | false | none | List of third party IDs associated with this customer |
BaseCustomerThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » customer | object | false | none | The customer this third party ID belongs to |
| »» id | string(uuid) | false | none | The customer ID (UUID7) |
| » systemName | string | false | none | The name of the third party system |
| » thirdPartyId | string | false | none | The ID from the third party system |
| » metadata | string¦null | false | none | Additional metadata for the third party ID |
| » tenant | object | false | none | The tenant this third party ID belongs to |
| »» id | string(uuid) | false | none | The tenant ID (UUID7) |
Contact
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseCustomer | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » firstName | string | false | none | First name |
| » lastName | string | false | none | Last name |
| » companyName | string | false | none | Company name |
| » civility | string | false | none | Contact's civility |
| » preferredMethodOfContact | string | false | none | Preferred method of contact |
| » accounts | [Account] | false | none | Associated accounts |
Lead
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
],
"category": "CAR",
"automationDay": 0,
"visitCount": 0,
"isTakeOver": false,
"isWalkAroundDone": false,
"walkAroundDate": "2019-08-24T14:15:22Z",
"takeOverDate": "2019-08-24T14:15:22Z",
"offerMade": true,
"offerMadeDate": "2019-08-24T14:15:22Z",
"soldDate": "2019-08-24T14:15:22Z",
"soldBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"presaleVisitCount": 0,
"postsaleVisitCount": 0,
"customerInitiated": true,
"inTransit": true,
"cpo": true,
"demo": true,
"formName": "string",
"leadHandlingInstructions": "string",
"creditAssessments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"incentives": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"packages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"surveys": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Connection | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » category | string¦null | false | none | The category of the lead |
| » automationDay | integer¦null | false | none | The automation day for the lead |
| » visitCount | integer | false | none | Number of visits for this lead |
| » isTakeOver | boolean | false | none | Whether the lead has been taken over |
| » isWalkAroundDone | boolean | false | none | Whether the walk around has been completed |
| » walkAroundDate | string(date-time)¦null | false | none | Date when the walk around was completed |
| » takeOverDate | string(date-time)¦null | false | none | Date when the lead was taken over |
| » offerMade | boolean¦null | false | none | Whether an offer has been made |
| » offerMadeDate | string(date-time)¦null | false | none | Date when the offer was made |
| » soldDate | string(date-time)¦null | false | none | Date when the lead was sold |
| » soldBy | object | false | none | The user who sold the lead |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » presaleVisitCount | integer | false | none | Number of pre-sale visits |
| » postsaleVisitCount | integer | false | none | Number of post-sale visits |
| » customerInitiated | boolean | false | none | Whether the lead was initiated by the customer |
| » inTransit | boolean¦null | false | none | Whether the lead is in transit |
| » cpo | boolean¦null | false | none | Whether the lead is a CPO (Certified Pre-Owned) |
| » demo | boolean¦null | false | none | Whether the lead is for a demo |
| » formName | string¦null | false | none | Name of the form used to capture the lead |
| » leadHandlingInstructions | string¦null | false | none | Instructions for handling the lead |
| » creditAssessments | [object] | false | none | List of credit assessments for this lead |
| »» id | string(uuid) | false | none | The credit assessment ID (UUID7) |
| » incentives | [object] | false | none | List of incentives for this lead |
| »» id | string(uuid) | false | none | The incentive ID (UUID7) |
| » packages | [object] | false | none | List of packages for this lead |
| »» id | string(uuid) | false | none | The package ID (UUID7) |
| » surveys | [object] | false | none | List of surveys for this lead |
| »» id | string(uuid) | false | none | The survey ID (UUID7) |
Connection
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » subject | string | false | none | The subject of the connection |
| » description | string¦null | false | none | Detailed description of the connection |
| » status | object | false | none | The status of the connection |
| »» id | string(uuid) | false | none | The status ID (UUID7) |
| » dateFirstModified | string(date-time)¦null | false | none | Date when the connection was first modified |
| » firstModifiedBy | object | false | none | User who first modified the connection |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » source | object | false | none | The source of the connection |
| »» id | string(uuid) | false | none | The source ID (UUID7) |
| » contact | object | false | none | The contact associated with this connection |
| »» id | string(uuid) | false | none | The contact ID (UUID7) |
| » account | object | false | none | The account associated with this connection |
| »» id | string(uuid) | false | none | The account ID (UUID7) |
| » franchise | object | false | none | The franchise associated with this connection |
| »» id | string(uuid) | false | none | The franchise ID (UUID7) |
| » dueDate | string(date-time)¦null | false | none | Due date for the connection |
| » stage | object | false | none | The stage of the connection |
| »» id | string(uuid) | false | none | The stage ID (UUID7) |
| » direction | string | false | none | The direction of the connection |
| » isQualified | boolean | false | none | Whether the connection is qualified |
| » connectionClosedDate | string(date-time)¦null | false | none | Date when the connection was closed |
| » connectionClosedBy | object | false | none | User who closed the connection |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » expectedDeliveryDate | string(date-time)¦null | false | none | Expected delivery date |
| » isLostApproved | boolean¦null | false | none | Whether the loss has been approved |
| » lostBy | object | false | none | User who marked the connection as lost |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » lostDate | string(date-time)¦null | false | none | Date when the connection was marked as lost |
| » firstOpenDate | string(date-time)¦null | false | none | Date when the connection was first opened |
| » firstOpenBy | object | false | none | User who first opened the connection |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » testDriveDone | boolean¦null | false | none | Whether a test drive has been done |
| » testDriveDate | string(date-time)¦null | false | none | Date when the test drive was done |
| » orderPlaced | boolean¦null | false | none | Whether an order has been placed |
| » orderDate | string(date-time)¦null | false | none | Date when the order was placed |
| » tradeInAppraisalDone | boolean¦null | false | none | Whether a trade-in appraisal has been done |
| » tradeInAppraisalDate | string(date-time)¦null | false | none | Date when the trade-in appraisal was done |
| » creditApplicationSubmitted | boolean¦null | false | none | Whether a credit application has been submitted |
| » creditApplicationSubmittedDate | string(date-time)¦null | false | none | Date when the credit application was submitted |
| » priority | integer¦null | false | none | Priority level of the connection |
| » thirdPartyIds | [ConnectionThirdPartyId] | false | none | List of third party IDs associated with this connection |
BaseRecord
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | IdEntity | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » dateCreated | string(date-time) | false | none | Date when the record was created |
| » createdBy | object | false | none | User who created the record |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » dateModified | string(date-time)¦null | false | none | Date when the record was last modified |
| » modifiedBy | object | false | none | User who last modified the record |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » isDeleted | boolean | false | none | Whether the record has been deleted |
| » dateDeleted | string(date-time)¦null | false | none | Date when the record was deleted |
| » deletedBy | object | false | none | User who deleted the record |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
| » dtype | string | false | none | The discriminator type of the record |
IdEntity
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier (UUID7) |
Filter
{
"field": "string",
"type": "string",
"label": "string",
"operators": [
"=",
"contains",
"in"
],
"options": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string | false | none | The field name to filter on |
| type | string | false | none | The type of the filter field |
| label | string | false | none | The human-readable label for the filter |
| operators | [string] | false | none | Available operators for this filter |
| options | object | false | none | Additional options for the filter (e.g., enum values) |
Enumerated Values
| Property | Value |
|---|---|
| type | string |
| type | number |
| type | boolean |
| type | date |
| type | datetime |
| type | enum |
EntityFilters
{
"entity": "string",
"filters": [
{
"field": "string",
"type": "string",
"label": "string",
"operators": [
"=",
"contains",
"in"
],
"options": {}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entity | string | false | none | The entity name |
| filters | [Filter] | false | none | List of available filters for this entity |
Franchise
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the franchise |
| » code | string | false | none | The franchise code |
| » isActive | boolean | false | none | Whether the franchise is active |
Product
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"sku": "string",
"name": "string",
"description": "string",
"defaultCost": "string",
"defaultSalesPrice": "string",
"defaultMargin": "string",
"currency": "string",
"productGroup": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": [
{}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sku | string | false | none | The SKU of the product |
| » name | string | false | none | The name of the product |
| » description | string | false | none | The description of the product |
| » defaultCost | string(decimal) | false | none | The default cost of the product |
| » defaultSalesPrice | string(decimal) | false | none | The default sales price of the product |
| » defaultMargin | string(decimal) | false | none | The default margin of the product |
| » currency | string | false | none | The currency of the product |
| » productGroup | ProductGroup | false | none | none |
ProductGroup
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": [
{}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the product group |
| » parent | ProductGroup¦null | false | none | The parent product group |
| » productGroups | [ProductGroup] | false | none | Child product groups |
LeadProduct
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"quantity": 0,
"cost": "string",
"salesPrice": "string",
"margin": "string",
"currency": "string",
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"sku": "string",
"name": "string",
"description": "string",
"defaultCost": "string",
"defaultSalesPrice": "string",
"defaultMargin": "string",
"currency": "string",
"productGroup": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": [
{}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
},
"productGroups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"parent": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {},
"dtype": "string",
"name": "string",
"parent": {},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
},
"productGroups": []
}
]
}
},
"lead": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
],
"category": "CAR",
"automationDay": 0,
"visitCount": 0,
"isTakeOver": false,
"isWalkAroundDone": false,
"walkAroundDate": "2019-08-24T14:15:22Z",
"takeOverDate": "2019-08-24T14:15:22Z",
"offerMade": true,
"offerMadeDate": "2019-08-24T14:15:22Z",
"soldDate": "2019-08-24T14:15:22Z",
"soldBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"presaleVisitCount": 0,
"postsaleVisitCount": 0,
"customerInitiated": true,
"inTransit": true,
"cpo": true,
"demo": true,
"formName": "string",
"leadHandlingInstructions": "string",
"creditAssessments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"incentives": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"packages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"surveys": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » quantity | integer | false | none | The quantity of the product |
| » cost | string(decimal) | false | none | The cost of the product |
| » salesPrice | string(decimal) | false | none | The sales price of the product |
| » margin | string(decimal) | false | none | The margin of the product |
| » currency | string | false | none | The currency of the product |
| » product | Product | false | none | none |
| » lead | Lead | false | none | none |
Survey
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"description": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the survey |
| » description | string¦null | false | none | The description of the survey |
Incentive
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"incentiveId": "string",
"name": "string",
"source": "string",
"description": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » incentiveId | string¦null | false | none | The incentive ID |
| » name | string | false | none | The name of the incentive |
| » source | string¦null | false | none | The source of the incentive |
| » description | string¦null | false | none | The description of the incentive |
Package
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"type": "string",
"termMonths": 0,
"name": "string",
"items": [
{}
],
"prices": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"type": "string",
"value": "string",
"currency": "string",
"source": "string"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » type | string | false | none | The type of the package |
| » termMonths | integer¦null | false | none | The term in months for the package |
| » name | string | false | none | The name of the package |
| » items | [object] | false | none | The items in the package |
| » prices | [PackagePrice] | false | none | The prices for the package |
PackagePrice
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"type": "string",
"value": "string",
"currency": "string",
"source": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » type | string | false | none | The type of the price |
| » value | string(decimal)¦null | false | none | The value of the price |
| » currency | string | false | none | The currency of the price |
| » source | string¦null | false | none | The source of the price |
TaskRequest
{
"type": "CALL",
"assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
"connection": "05107f3a-70a0-49c6-879b-3a441d6562d4"
}
Request body for creating or updating a task
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | The type of task |
| assignee | string(uuid) | true | none | The ID of the security object assigned to the task |
| start | string(date-time)¦null | false | none | The start date and time of the task |
| end | string(date-time)¦null | false | none | The end date and time of the task |
| title | string | true | none | The title of the task |
| note | string¦null | false | none | The note/description of the task |
| contact | string(uuid)¦null | false | none | The ID of the contact associated with this task |
| account | string(uuid)¦null | false | none | The ID of the account associated with this task |
| connection | string(uuid)¦null | false | none | The ID of the connection associated with this task |
Enumerated Values
| Property | Value |
|---|---|
| type | CALL |
| type | |
| type | MEETING |
| type | OTHER |
| type | SMS |
| type | FOLLOW_UP |
| type | REMINDER |
| type | LINKEDIN_MESSAGE |
| type | DM |
Automation
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"automationTrigger": "string",
"nodes": [
{}
],
"edges": [
{}
],
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
},
"delayedAutomationsCount": 0
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the automation |
| » automationTrigger | string | false | none | The trigger type for this automation |
| » nodes | [object] | false | none | The nodes configuration for the automation workflow |
| » edges | [object] | false | none | The edges configuration for the automation workflow |
| » franchise | Franchise | false | none | none |
| » delayedAutomationsCount | integer | false | none | The number of delayed automations associated with this automation |
User
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"username": "string",
"email": "user@example.com",
"firstname": "string",
"lastname": "string",
"signature": "string",
"mobilePhone": "string",
"stopEscalation": false,
"userType": "USER",
"roundRobinStatus": "string",
"isThirdPartyProvider": false,
"apiKey": "string",
"versionNumber": "string",
"versionDontShowAgain": true,
"isImpersonated": false,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » username | string | false | none | The unique username for the user |
| string(email) | false | none | The user's email address | |
| » firstname | string¦null | false | none | The user's first name |
| » lastname | string¦null | false | none | The user's last name |
| » signature | string¦null | false | none | The user's signature |
| » mobilePhone | string¦null | false | none | The user's mobile phone number |
| » stopEscalation | boolean | false | none | Whether escalation should be stopped for this user |
| » userType | string | false | none | The type of user |
| » roundRobinStatus | string¦null | false | none | The round robin status of the user |
| » isThirdPartyProvider | boolean | false | none | Whether the user is a third party provider |
| » apiKey | string¦null | false | none | The user's API key |
| » versionNumber | string¦null | false | none | The version number for the user |
| » versionDontShowAgain | boolean¦null | false | none | Whether to show version notifications again |
| » isImpersonated | boolean | false | none | Whether the user is currently being impersonated |
| » thirdPartyIds | [UserThirdPartyId] | false | none | List of third party IDs associated with this user |
Enumerated Values
| Property | Value |
|---|---|
| userType | USER |
| userType | ADMIN |
| userType | MANAGER |
SecurityObject
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » isGroup | boolean | false | none | Whether this security object is a group |
| » displayName | string | false | none | The display name of the security object |
| » isBackEnd | boolean | false | none | Whether this is a backend security object |
| » isDisableable | boolean | false | none | Whether this security object can be disabled |
| » isActive | boolean | false | none | Whether this security object is active |
| » franchises | [object] | false | none | The franchises associated with this security object |
| »» id | string(uuid) | false | none | The franchise ID (UUID7) |
| » departments | [object] | false | none | The departments associated with this security object |
| »» id | string(uuid) | false | none | The department ID (UUID7) |
| » assignationTypes | [object] | false | none | The assignation types associated with this security object |
| »» id | string(uuid) | false | none | The assignation type ID (UUID7) |
| » tenant | Tenant | false | none | none |
| » additionalTenants | [object] | false | none | Additional tenants associated with this security object |
| »» id | string(uuid) | false | none | The tenant ID (UUID7) |
SecurityGroup
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"roundRobin": true,
"membersOrder": [
"string"
],
"members": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the security group |
| » roundRobin | boolean¦null | false | none | Whether round robin is enabled for this group |
| » membersOrder | [string]¦null | false | none | The order of members in the group |
| » members | [object] | false | none | The users who are members of this security group |
| »» id | string(uuid) | false | none | The user ID (UUID7) |
Role
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "Sales Manager",
"permissions": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "CAN_EDIT_USER",
"roles": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "Sales Manager",
"permissions": [],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
}
}
]
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » name | string | false | none | The name of the role |
| » permissions | [Permission] | false | none | The permissions associated with this role |
| » tenant | Tenant | false | none | none |
RoleType
{
"name": "Sales Manager",
"permissions": [
"293934ac-c55a-4a69-b61c-aa6d16831bc5",
"456789ab-cdef-4a69-b61c-aa6d16831bc5"
]
}
Form type for creating and editing Role entities
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | The name of the role |
| permissions | [string] | true | none | Array of permission IDs to associate with this role |
ValidationError
{
"errors": [
"Role name is required",
"At least one permission must be selected"
],
"message": "Validation failed"
}
Validation error response
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [string] | false | none | Array of validation error messages |
| message | string | false | none | General error message |
AccessDeniedError
{
"error": "Access denied"
}
Access denied error response
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | false | none | Error message |
NotFoundError
{
"error": "Role not found"
}
Not found error response
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | false | none | Error message |
UserSettings
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"username": "string",
"email": "user@example.com",
"firstname": "string",
"lastname": "string",
"signature": "string",
"mobilePhone": "string",
"stopEscalation": false,
"userType": "USER",
"roundRobinStatus": "string",
"isThirdPartyProvider": false,
"apiKey": "string",
"versionNumber": "string",
"versionDontShowAgain": true,
"isImpersonated": false,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"audioInput": "string",
"audioOutput": "string",
"dueDateDisplayType": 0,
"connectionViewType": 0,
"language": "FR",
"isEmailNotificationsEnabled": true,
"isPushNotificationsEnabled": true,
"isAnytimeCallingEnabled": false,
"managementViewSettings": {},
"frontendState": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | IdEntity | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » user | User | false | none | none |
| » audioInput | string¦null | false | none | The audio input device setting |
| » audioOutput | string¦null | false | none | The audio output device setting |
| » dueDateDisplayType | integer | false | none | The type of due date display |
| » connectionViewType | integer | false | none | The type of connection view |
| » language | string | false | none | The user's preferred language |
| » isEmailNotificationsEnabled | boolean | false | none | Whether email notifications are enabled |
| » isPushNotificationsEnabled | boolean | false | none | Whether push notifications are enabled |
| » isAnytimeCallingEnabled | boolean | false | none | Whether anytime calling is enabled |
| » managementViewSettings | object¦null | false | none | User-specific management view settings |
| » frontendState | string¦null | false | none | The frontend state of the user settings |
LeadCreateRequest
{
"subject": "string",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"makeStr": "string",
"modelStr": "string",
"yearStr": "stri",
"trimStr": "string",
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"assignees": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"description": "string",
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"category": "CAR",
"utmCampaign": "string",
"utmSource": "string",
"customerInitiated": true,
"leadHandlingInstructions": "string",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"customFieldValues": [
{
"field": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"value": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| subject | string | true | none | The subject/title of the lead |
| department | object | true | none | The department this lead belongs to |
| » id | string(uuid) | false | none | The department ID (UUID7) |
| makeStr | string¦null | false | none | The make of the vehicle |
| modelStr | string¦null | false | none | The model of the vehicle |
| yearStr | string¦null | false | none | The year of the vehicle |
| trimStr | string¦null | false | none | The trim of the vehicle |
| contact | object | true | none | The contact associated with this lead |
| » id | string(uuid) | false | none | The contact ID (UUID7) |
| account | object¦null | false | none | The account associated with this lead |
| » id | string(uuid) | false | none | The account ID (UUID7) |
| assignees | [object] | false | none | List of users assigned to this lead |
| » id | string(uuid) | false | none | The user ID (UUID7) |
| description | string¦null | false | none | Detailed description of the lead |
| source | object | true | none | The source of the lead |
| » id | string(uuid) | false | none | The source ID (UUID7) |
| category | string¦null | false | none | The category of the lead |
| utmCampaign | string¦null | false | none | UTM campaign parameter |
| utmSource | string¦null | false | none | UTM source parameter |
| customerInitiated | boolean | false | none | Whether the lead was initiated by the customer |
| leadHandlingInstructions | string¦null | false | none | Instructions for handling the lead |
| franchise | object | true | none | The franchise this lead belongs to |
| » id | string(uuid) | false | none | The franchise ID (UUID7) |
| customFieldValues | [object]¦null | false | none | Custom field values for this lead |
| » field | object | false | none | The custom field |
| »» id | string(uuid) | false | none | The custom field ID (UUID7) |
| » value | string | false | none | The value of the custom field |
CopyLeadData
{
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"subject": "New Lead Copy",
"department": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sales New",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
},
"pipeline": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
}
}
Data transfer object for copying a lead with new contact, account, and other optional parameters
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contact | Contact | true | none | none |
| account | Account¦null | false | none | The account to associate with the copied lead (optional) |
| subject | string¦null | false | none | The subject for the copied lead (optional, will use original if not provided) |
| department | Department¦null | false | none | The department to assign the copied lead to (optional, will use original if not provided) |
| franchise | Franchise¦null | false | none | The franchise to assign the copied lead to (optional, will use original if not provided) |
Department
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sales New",
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "string",
"code": "string",
"isActive": true
},
"pipeline": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
}
A department within a franchise
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier of the department (UUID7) |
| name | string | false | none | The name of the department |
| franchise | Franchise | false | none | none |
| pipeline | object | false | none | The pipeline associated with this department |
| » id | string(uuid) | false | none | The pipeline ID (UUID7) |
| » name | string | false | none | The name of the pipeline |
Permission
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "CAN_EDIT_USER",
"roles": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"name": "Sales Manager",
"permissions": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "CAN_EDIT_USER",
"roles": []
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
}
}
]
}
A permission that defines what actions a user can perform
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | The unique identifier of the permission (UUID7) |
| name | string | false | none | The name of the permission |
| roles | [Role] | false | none | The roles that have this permission |
EventBase
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
}
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » connection | Connection¦null | false | none | The connection associated with this event |
| » start | string(date-time)¦null | false | none | The start date and time of the event |
| » end | string(date-time)¦null | false | none | The end date and time of the event |
| » title | string | false | none | The title of the event |
| » note | string | false | none | The note/description of the event |
| » assignee | SecurityObject | false | none | none |
| » taskDone | boolean | false | none | Whether the task is done |
| » notified | boolean | false | none | Whether notifications have been sent |
| » edited | boolean¦null | false | none | Whether the event has been edited |
| » tenant | Tenant | false | none | none |
| » contact | Contact¦null | false | none | The contact associated with this event |
| » account | Account¦null | false | none | The account associated with this event |
Task
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"type": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EventBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » type | string¦null | false | none | The type of task |
Appointment
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"type": "string",
"noShow": false,
"customerConfirmed": false,
"canceled": false,
"url": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EventBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » type | string | false | none | The type of appointment |
| » noShow | boolean | false | none | Whether the customer showed up for the appointment |
| » customerConfirmed | boolean | false | none | Whether the customer confirmed the appointment |
| » canceled | boolean | false | none | Whether the appointment was canceled |
| » url | string¦null | false | none | URL associated with the appointment |
FollowUp
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"subject": "string",
"description": "string",
"status": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateFirstModified": "2019-08-24T14:15:22Z",
"firstModifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"franchise": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dueDate": "2019-08-24T14:15:22Z",
"stage": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"direction": "string",
"isQualified": true,
"connectionClosedDate": "2019-08-24T14:15:22Z",
"connectionClosedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"isLostApproved": true,
"lostBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"lostDate": "2019-08-24T14:15:22Z",
"firstOpenDate": "2019-08-24T14:15:22Z",
"firstOpenBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"testDriveDone": true,
"testDriveDate": "2019-08-24T14:15:22Z",
"orderPlaced": true,
"orderDate": "2019-08-24T14:15:22Z",
"tradeInAppraisalDone": true,
"tradeInAppraisalDate": "2019-08-24T14:15:22Z",
"creditApplicationSubmitted": true,
"creditApplicationSubmittedDate": "2019-08-24T14:15:22Z",
"priority": 0,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
]
},
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"title": "string",
"note": "string",
"assignee": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"isGroup": true,
"displayName": "string",
"isBackEnd": false,
"isDisableable": true,
"isActive": true,
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"departments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"assignationTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"additionalTenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
},
"taskDone": false,
"notified": false,
"edited": true,
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"vertical": "default",
"franchises": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"users": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"customLabels": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"value": {
"label1": "Custom Label 1",
"label2": "Custom Label 2"
}
}
]
},
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
}
]
}
]
},
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"name": "string",
"primaryContact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primaryEmail": "user@example.com",
"secondaryEmail": "user@example.com",
"homePhone": "string",
"workPhone": "string",
"workPhoneExtension": "string",
"mobilePhone": "string",
"address": "string",
"city": "string",
"province": "strin",
"postalCode": "string",
"country": "string",
"language": "fr-CA",
"isActive": true,
"thirdPartyIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"customer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"systemName": "CRM_SYSTEM_A",
"thirdPartyId": "CUSTOMER_12345",
"metadata": "{\"source\": \"web_form\", \"campaign\": \"summer_sale\"}",
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
],
"firstName": "string",
"lastName": "string",
"companyName": "string",
"civility": "string",
"preferredMethodOfContact": "string",
"accounts": []
},
"contacts": []
}
]
}
]
},
"fromAutomation": false
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EventBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » fromAutomation | boolean | false | none | Whether this follow-up was created by automation |
ThirdPartyIdType
{
"systemName": "string",
"thirdPartyId": "string",
"metadata": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| systemName | string | false | none | The system name |
| thirdPartyId | string | false | none | The third party ID |
| metadata | any | false | none | none |
ThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BaseRecord | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » systemName | string | false | none | The system name |
| » thirdPartyId | string | false | none | The third party ID |
| » metadata | string¦null | false | none | The metadata |
UserThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ThirdPartyId | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
ContactThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ThirdPartyId | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
ConnectionThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ThirdPartyId | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
ProductThirdPartyId
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dateCreated": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dateModified": "2019-08-24T14:15:22Z",
"modifiedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"isDeleted": false,
"dateDeleted": "2019-08-24T14:15:22Z",
"deletedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"dtype": "string",
"systemName": "string",
"thirdPartyId": "string",
"metadata": "string"
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ThirdPartyId | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
Automation2
{}
Properties
None
Automation3
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
},
"delayedAutomationsCount": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| automationTrigger | string | true | none | none |
| nodes | [any] | false | none | none |
| edges | [any] | false | none | none |
| franchise | Franchise2¦null | false | none | A franchise entity |
| delayedAutomationsCount | integer | true | none | none |
EntityFilters2
{
"entity": "string",
"filters": [
null
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entity | string | true | none | none |
| filters | [any] | true | none | none |
Filter2
{
"field": "string",
"type": "string",
"label": "string",
"operators": [
null
],
"options": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string | true | none | none |
| type | string | true | none | none |
| label | string | true | none | none |
| operators | [any] | true | none | none |
| options | [any]¦null | false | none | none |
Franchise2
{
"automations": [
{
"name": "string",
"automationTrigger": "string",
"nodes": [],
"edges": [],
"franchise": {
"automations": []
},
"delayedAutomationsCount": 0
}
]
}
Franchise
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| automations | [Automation3] | true | none | none |