BackOffice Admin
Welcome to CRM.COM Application Programming Interface (API) documentation
The CRM.COM API is designed around REST, allowing you to access and extend the software’s current functionality in a simple, programmatic way using intuitive URL endpoints, conventional HTTP requests, response codes, authentication and verbs.
Back-Office API is designed with a main focus on users and external systems that desire to access and extend the functionality found in CRM.COM.
For the Mobile/Web based Applications API please refer to the Self-Service API documentation that provides more details how to allow contacts to manage their subscription and/or reward accounts.
CRM.COM is built on a domain based micro-service architecture. Our primary resources such as Contact, Account, Wallet, Products and Subscriptions are all created with a unique identifier that uses a performant time based GUID. These are generated when a new resource such as a contact is created. However in some cases external integration may wish to use a unique identfier that is stored in an external system, such as a Bank CIF or Credit Card fingerprint.
Some systems allow from their create APIs to supply a unique identifier as part of the request body. CRM.COM has decided to provide an alternative approach and make an alternative unique identifier available on resources (e.g. on Contacts we provide the contact.code). If such attribute is specified during the create operation it wil be available on subsequent operations as a resource’s identifier, alongside with the GUID that is returned in the response body.
CRM.COM API is organized around REST. Our API has specific resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses and uses standard HTTP response codes, authentication & verbs.
You can use the entire API in test mode, which does not affect your live data. The API Key used to authenticate any of your requests will determine whether the request is on live mode or test mode.
The API may differ based on each CRM.COM release. For every new release with noticable changes that might alter backwards compatibility, a new version will be created.
CRM.COM Back-Office API uses either API Keys to authenticate requests or an authentication JWT token obtained from a user successful logging in.
All API requests must be made over HTTPS. Any request made over plain HTTP or without authentication will fail. In addition, API Keys carry many privileges, so be sure to keep them secure! Do not share your secret API Keys in publicly accessible areas, such as GitHub or client-side code.
API KEY AUTHORIZATION HEADER EXAMPLE
curl -X $HTTP_METHOD -H "api_key: 2189341e-981e-9ad5-9912-11101670314a"
AUTH TOKEN AUTHORIZATION HEADER EXAMPLE
curl -X $HTTP_METHOD -H "authorization: Bearer JWT_TOKEN"
API requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.
| Method | Usage |
|---|---|
| POST | To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object to the targeted endpoint. |
| PUT | To update the information on an existing object, the PUT method should be used. This will update the specified object if it is found using the provided values, regardless of their current values. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource’s availability prior to issuing an update command, the final state will be the same regardless of its existence. Requests using the PUT method do not need to check the current attributes of the object. |
| DELETE | To remove an existing object from your environment, the DELETE method should be used. Similar to PUT method, the DELETE method is idempotent. |
| GET | For retrieving information about customers, purchases or orders, the GET method should be used. Any requested information will be returned as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the retrieved objects. |
Along with the HTTP methods that the API responds to, CRM.COM uses conventional HTTP response codes and human-readable messages in JSON format to indicate the success or failure of an API request.
In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.
| HTTP Status | Description |
|---|---|
| 2XX | Return codes in the 200 range indicate that the request was fulfilled successfully and that no error was encountered. |
| 4XX | Return codes in the 400 range, typically, indicate that there was an issue with the request that was sent. Most common reasons could be an invalid authentication method, unauthorised requests or the object that you are requesting does not exist. |
| 5XX | Return codes in the 500 range indicate that there is a server-side problem and CRM.COM cannot fulfill your request at the moment. |
Most of our 4XX range errors that could be handled programmatically contain all the necessary details for a better integration handling. Such details are
- HTTP Status Code & Error are used for programmatic consumption
- Message is human-readable and can be used as a default error message
- Parameters are used for programmatic consumption and can be used for enhancing the interface error message with additional information
4XX ERROR RESPONSE EXAMPLE
An example of a customer not found error is as follows
HTTP/1.1 404 Not Found
{
"status": 404,
"message": "Record not found.",
"error": "CRM.EXCEPTIONS.NOTFOUNDEXCEPTION",
"parameters": [
"contact",
"789dacae-cf71-414f-9483-ca88acaa46432"
]
}
The request has succeeded
The request has succeeded
The input request was invalid or incorrect, often due to missing a required parameter
The client request has not been completed because it lacks valid authentication credentials for the requested resource
The API key or Token does not have permissions to perform the request
The requested resource does not exist
The server is unwilling to process a request because it may be replayed
The server encountered an unexpected condition which prevented it from fulfilling the request
The server received an invalid response from the upstream server it accessed in attempting to fulfill the request
The server is currently unable to handle the request due to a temporary overloading or maintenance
The server did not receive a timely response from the upstream server
The ledger of customer financial transactions such as invoices and payments. An account has a set currency and credit terms and outputs balances such as running balance, overdue amount and pending balance per accounting period. Many processes within CRM.COM are carried out against an account, such as placing an order or creating a subscription.
{id}{id}{id}/accounts{id}/accounts{id}/actions{id}Get a single Account with its financial information
Path variables
The unique identifier of the Account
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the account
The account’s name
The account’s number
Defines whether the account is the primary one of the contact
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
The account’s running balance
The unpaid amount that is passed its due date
The account’s credit limit.
The account’s payment terms
Payment terms unique identifier
Payment terms nane
Details about the event classification
The classification identifier
The classification name
The id of the billing address
Address line 1
Address line 2
GET https://sandbox.crm.com/backoffice/v2/accounts/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "AC00123456 John Smith",
"number": "AC00123456",
"is_primary": "true",
"state": "ACTIVE",
"currency_code": "EUR",
"balance": 99.99,
"overdue_amount": 9.99,
"credit_limit": 99.99,
"payment_terms": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Net 7"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"billing_address": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"address_line_1": "2265 Oak Street",
"address_line_2": "",
"state_province_county": "New York",
"town_city": "Old Forge",
"postal_code": "13420",
"country_code": "CYP"
}
}{id}Update the account of a contact or organisation. A single account can be updated per Web API call. Select to update at least one of the account’s basic attributes
Path variables
The account (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
If set to true, then this account will be set as the primary one, unmarking the previous account from being the primary.
The account’s classification identifier
The unique identifier of a contact address which will be set as the billing address of the account.
Sets the credit limit of the account. The credit limit is set in the account’s currency
Sets the Account’s Payment Terms.
Responses
The request has succeeded
Body
The account identifier
PUT https://sandbox.crm.com/backoffice/v2/accounts/a2c0809f-ed91-4b68-b912-5bd6064d602a HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"is_primary": true,
"classification_id": "d230809f-ed91-4b68-b912-5bd6064d602a",
"billing_address_id": "a345fb9f-ed91-4b68-b912-5bd6064d602a",
"credit_limit": 20.99,
"payment_terms_id": "d230809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d230809f-ed91-4b68-b912-5bd6064d602a"
}{id}/accountsGet a list of Contact Accounts. Normally a contact will have a single account but multiple accounts can be used to service different currencies. All accounts of the contact are retrieved by default, regardless of their state
Path variables
The contact identifier whose accounts will be retrieved
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
If set to true, then only the primary account of the contact will get retrieved. If not specified, then all accounts are retrieved including terminated ones
Filter accounts based on whether they are Active, Suspended and or Terminated. If not specified then all contact accounts are retrieved, even terminated ones.
[
"ACTIVE"
]Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The account identifier
Indicates if this is the primary account of the contact
The account name
The Account number. This is a unique number across all Accounts
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
Details about the event classification
The classification identifier
The classification name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/a2c0809f-ed91-4b68-b912-5bd6064d602a/accounts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"is_primary": true,
"name": "AC123456 John Smith",
"number": "AC123456",
"state": "ACTIVE",
"currency_code": "EUR",
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/accountsCreate a new Account for a contact. A contact can have multiple accounts, each one having a different currency. A contact can own a single primary account.
Path variables
The unique identifier of the contact for which the new account is created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Mark the new account as the contact’s primary account. If contact has another account marked as the primary, then this setting will enforce the new account to be the primary, unmarking the other one from being the primary.
The account’s name. If not specified, then a name will be assigned by CRM.COM based on account name rules
The account’s classification. If not specified, then the default Classification is set
The unique identifier of a contact address which will be set as the billing address of the account.
Responses
Created
Body
The account identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/3ec0809f-ed91-4458-b912-5bd6064dabf1/accounts HTTP/1.1
Content-Type: application/json
{
"is_primary": true,
"currency_code": "EUR",
"name": "John Smith Main account",
"classification_id": "a2c0809f-ed91-4b68-b912-5bd6064d602a",
"billing_address_id": "e230809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "b4c0809f-ed91-4b68-b912-5bd60545902a"
}{id}/actionsUse this Web API to update the account’s state. The new state to which the account will be updated to also denotes the action performed on it, for example terminating or reactivating the account.
Path variables
The account identifier on which the action is performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
The account to which any account balance will get transfered, in case of Termination. Applicable and required when terminating the account. If not specified on terminating the account, the terminated account’s balance is lost
Responses
Successful Request
Body
The unique identifier of the account
POST https://sandbox.crm.com/backoffice/v2/accounts/1eaa809f-ed91-4b68-b912-5bd6064d3400/actions HTTP/1.1
Content-Type: application/json
{
"state": "ACTIVE",
"account_id": "2ee0809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "b560809f-ed91-4b68-b912-5bd6064d602a"
}{id}{id}{id}Create a new activity
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity name
The activity description
The activity type (identifier)
The contact address (identifier) associated to the activity
Use the entity address as the Activity address. In cases where an Activity is being created for an entity which has an address (e.g. Contact, Order, Service Request) then use that address as the default Activity address. Either the address_id or the use_entity_address can be specified, not both
The scheduled from date/time
The scheduled to date/time
The related entities for the activity. Contact should always be specified and optionally one of the the rest entities (orders, service requests, leadds) can be specified as well
[
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
},
{
"type": "CONTACT",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
]The type of related entity.
The related entity identifier
The user identifier
The team identifier
The custom field’s unique key
The custom field’s value
Responses
The request has succeded
Body
The activity identifier
POST https://sandbox.crm.com/backoffice/v2/activities HTTP/1.1
Content-Type: application/json
{
"name": "Call customer",
"description": "We need to call the contact (after 4pm) in order to schedule a demo",
"type_id": "cdd8e232-ddce-87c0-44fd-27f44035a252",
"address_id": "4d1b276d-6ae9-eca3-8c61-aedd35ebb9a4",
"use_entity_address": "false",
"scheduled_on": {
"from_date": 1592809457,
"to_date": 11653396172
},
"linked_to": [
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "81b8d150-1196-6e6a-1df9-aaf23adc757d"
}{id}Update an existing activity
Path variables
The activity (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity name
The activity description
The activity state
The contact address (identifier) associated to the activity
The scheduled from date/time
The scheduled to date/time
The related entities for the activity, contact cannot be updated
[
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
]The type of related entity.
The related entity identifier
The user identifier
The team identifier
The custom field’s unique key
The custom field’s value
Responses
The request has succeded
Body
The activity identifier
PUT https://sandbox.crm.com/backoffice/v2/activities/43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2 HTTP/1.1
Content-Type: application/json
{
"name": "Approve Offers",
"description": "Require 4 approvals for an offer",
"state": "CANCELLED",
"address_id": "6cbe314d-9f32-d3c7-4be6-f453e7b8e77e",
"scheduled_on": {
"from_date": 1592809457,
"to_date": 11653396172
},
"linked_to": [
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2"
}{id}Delete an existing activity
Path variables
The activity (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/activities/52cbb887-a61a-9b1e-63df-1303f7b5718a HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of activities based on search criteria (e.g. all open activities)
Request parameters
Filter based on search values, such as name (behave as like)
Filter based on activity type(s)
Filter based on related contact
Filter based on related service request
Filter based on related lead
Filter based on related order
Filter based on activity state
Filter based on activity tags
Defines whether tags should be retrieved or not
Filter based on the created date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. created_on[gte]=1618395497&created_on[lt]=1618395497).
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
Filter based on the completed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. completed_on[gte]=1618395497&completed_on[lt]=1667890564).
Returns results where the date is greater than this value
Returns results where the date is greater than or equal to this value
Returns results where the date is less than this value
Returns results where the date is less then or equal to this value
Filters based on specific assign to user
Filters based on specific assign to team
Filters based on custom fields (key/value set should be semicolon separated)
Defines whether custom fields should be retrieved or not (via List/Get APIs)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The activity identifier
The activity name
The activity description
The activity state
The date that the activity was created
The date/time that the activity is scheduled
The scheduled from date
The scheduled to date
The activity type
The activity type identifier
The activity type name
The activity type color (hex code), used for visual purposes
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The lead identifier
The lead title
The order identifier
The order number
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
The custom field (unique) key
The custom field’s (provided) value
Tag unique id
Tag name
The colour of the tag - for list view only
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/activities/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1cf0d458-b799-1d99-52e4-d7f5081b3c01",
"name": "Call customer",
"description": "We need to call the customer to arrange a demo",
"state": "CANCELLED",
"key_dates": {
"created_on": 1592809457,
"scheduled_on": {
"from_date": 1592809457,
"to_date": 1592809457
}
},
"type": {
"id": "HGJDHGSJDHG",
"name": "site visit",
"color": "876FD5"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"lead": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"title": "ASOS"
},
"service_request": {
"id": "JHGHGF7576HGFTGD564654",
"number": "SRV78001"
},
"order": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"number": "O101367"
},
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
],
"tags": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an activity
Path variables
The activity (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The activity identifier
The activity name
The activity description
The date that the activity was created
The date/time that the activity is scheduled
The scheduled from date
The scheduled to date
The activity type
The activity type identifier
The activity type name
The activity type color (hex code), used for visual purposes
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The lead identifier
The lead title
The order identifier
The order number
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The activity states history
The activity state
The date on which the state was reached
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
The custom field (unique) key
The custom field’s (provided) value
GET https://sandbox.crm.com/backoffice/v2/activities/6215f115-321a-c3d4-8809-59ca5f502433 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6215f115-321a-c3d4-8809-59ca5f502433",
"name": "Call customer",
"description": "Arrange a call with the customer after 4pm to schedule a demo for next week",
"key_dates": {
"created_on": 1592809457,
"scheduled_on": {
"from_date": 1592809457,
"to_date": 1592809457
}
},
"type": {
"id": "HGJDHGSJDHG",
"name": "site visit",
"color": "876FD5"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"service_request": {
"id": "JHGHGF7576HGFTGD564654",
"number": "SRV78001"
},
"lead": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"title": "ASOS"
},
"order": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"number": "O101367"
},
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"states": [
{
"state": "COMPLETED",
"date": 1653400142
}
],
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
]
}{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the activity
Path variables
The activity (identifier) on which tags will be upaded
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The activity identifier
PUT https://sandbox.crm.com/backoffice/v2/activities/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the activity
Path variables
The activity (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/activities/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}{id}/analytics{id}/analytics{id}{id}/{id}{id}/events{id}/filters{id}/breakdowns{id}/results{id}/preview{id}/exportsCreate a new insight
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The insight name
The insight description
Responses
Body
The insight identifier