BackOffice Admin

https://sandbox.crm.com/backoffice/v2
Introduction

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.

Change Log

Expected Release Date Jun 2022

This is the second release of the CRM V5 APIs

API Documentation
Unique Resource Identifiers

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.

API Reference

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.

Authentication

CRM.COM Back-Office API uses either API Keys to authenticate requests or an authentication JWT token obtained from a user successful logging in.

SECURITY NOTICE

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" 
Requests

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.
Responses

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"
        ]
    }
Response Codes

Below is a list of our common HTTP response codes that can be returned.

200 OK

The request has succeeded

201 Created
204 No Content

The request has succeeded

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

425 Too Early

The server is unwilling to process a request because it may be replayed

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Operations
Accounts

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.

GET /accounts/{id}
PUT /accounts/{id}
GET /contacts/{id}/accounts
POST /contacts/{id}/accounts
POST /accounts/{id}/actions
Get Account
GET /accounts/{id}

Get a single Account with its financial information

Path variables

id
string GUID required

The unique identifier of the Account

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

200 200

OK

Body
Object
id
string

The unique identifier of the account

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e
name
string

The account’s name

Example:
AC00123456 John Smith
number
string

The account’s number

Example:
AC00123456
is_primary
boolean

Defines whether the account is the primary one of the contact

Example:
true
state
string
Enumeration:
ACTIVE

Contact is able to perform transactions

SUSPENDED

Contact blocked from ordering/purchases but still allowed to make Payments

TERMINATED

Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)

Example:
ACTIVE
currency_code
string
Min length: 3
Max length: 3
Pattern: 3-letter ISO 4217 currency code.
Example:
EUR
balance
number

The account’s running balance

Example:
99.99
overdue_amount
number

The unpaid amount that is passed its due date

Example:
9.99
credit_limit
number

The account’s credit limit.

Example:
99.99
payment_terms
Object

The account’s payment terms

id
string

Payment terms unique identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

Payment terms nane

Example:
Net 7
classification
Object

Details about the event classification

id
string GUID

The classification identifier

Example:
c8d83493-3f50-40df-adb0-762ec5f41863
name
string

The classification name

Example:
Delivery Purchase
billing_address
Object
id
string GUID

The id of the billing address

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e
address_line_1
string

Address line 1

Example:
2265 Oak Street
address_line_2
string

Address line 2

state_province_county
string
Example:
New York
town_city
string
Example:
Old Forge
postal_code
string
Example:
13420
country_code
string
Min length: 3
Max length: 3
Pattern: 3-letter ISO 3166-1 country code.
Example:
CYP
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
    }
}
Update Account
PUT /accounts/{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

id
string GUID required

The account (identifier) that will be updated

Example:
a2c0809f-ed91-4b68-b912-5bd6064d602a

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

Object
is_primary
boolean nullable

If set to true, then this account will be set as the primary one, unmarking the previous account from being the primary.

Example:
true
classification_id
string GUID nullable

The account’s classification identifier

Example:
d230809f-ed91-4b68-b912-5bd6064d602a
billing_address_id
string GUID nullable

The unique identifier of a contact address which will be set as the billing address of the account.

Example:
a345fb9f-ed91-4b68-b912-5bd6064d602a
credit_limit
number nullable

Sets the credit limit of the account. The credit limit is set in the account’s currency

Example:
20.99
payment_terms_id
string nullable

Sets the Account’s Payment Terms.

Example:
d230809f-ed91-4b68-b912-5bd6064d602a

Responses

200 OK

The request has succeeded

Body
Object
id
string GUID

The account identifier

Example:
d230809f-ed91-4b68-b912-5bd6064d602a
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
List Contact Accounts
GET /contacts/{id}/accounts

Get 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

id
string GUID required

The contact identifier whose accounts will be retrieved

Example:
a2c0809f-ed91-4b68-b912-5bd6064d602a

Request parameters

sort
string optional

Defines on which attribute the results should be sorted

Default:
CREATED_DATE
Examples:
CREATED_DATEUPDATED_DATENAMESCHEDULED_DATE
page
integer optional

The page number that should be retrieved

Default:
1
size
integer optional

The size (total records) of each page

Default:
10
order
string optional

Defines how the results will be ordered

Default:
DESC
is_primary
boolean optional

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

Default:
false
Example:
true
state
array of Account State (Enum) optional

Filter accounts based on whether they are Active, Suspended and or Terminated. If not specified then all contact accounts are retrieved, even terminated ones.

Collection format: csv
Example:
[
    "ACTIVE"
]

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

200 200

OK

Body
Object
content
Array
Object
id
string GUID

The account identifier

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e
is_primary
boolean

Indicates if this is the primary account of the contact

Example:
true
name
string

The account name

Example:
AC123456 John Smith
number
string

The Account number. This is a unique number across all Accounts

Example:
AC123456
state
string
Enumeration:
ACTIVE

Contact is able to perform transactions

SUSPENDED

Contact blocked from ordering/purchases but still allowed to make Payments

TERMINATED

Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)

Example:
ACTIVE
currency_code
string
Min length: 3
Max length: 3
Pattern: 3-letter ISO 4217 currency code.
Example:
EUR
classification
Object

Details about the event classification

id
string GUID

The classification identifier

Example:
c8d83493-3f50-40df-adb0-762ec5f41863
name
string

The classification name

Example:
Delivery Purchase
paging
Object
page
integer

The page number

Example:
2
size
integer

The number of records per page

Example:
20
total
integer

The overal number of records

Example:
5124
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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
    }
}
Add Account for Contact
POST /contacts/{id}/accounts

Create 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

id
string GUID required

The unique identifier of the contact for which the new account is created

Example:
3ec0809f-ed91-4458-b912-5bd6064dabf1

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

Object
is_primary
boolean nullable

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.

Default:
false
Example:
true
currency_code
string required
Min length: 3
Max length: 3
Pattern: 3-letter ISO 4217 currency code.
Example:
EUR
name
string

The account’s name. If not specified, then a name will be assigned by CRM.COM based on account name rules

Example:
John Smith Main account
classification_id
string GUID

The account’s classification. If not specified, then the default Classification is set

Example:
a2c0809f-ed91-4b68-b912-5bd6064d602a
billing_address_id
string GUID nullable

The unique identifier of a contact address which will be set as the billing address of the account.

Example:
e230809f-ed91-4b68-b912-5bd6064d602a

Responses

201 201

Created

Body
Object
id
string GUID

The account identifier

Example:
b4c0809f-ed91-4b68-b912-5bd60545902a
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
Account Actions
POST /accounts/{id}/actions

Use 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

id
string GUID required

The account identifier on which the action is performed

Example:
1eaa809f-ed91-4b68-b912-5bd6064d3400

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

Object
state
string required
Enumeration:
ACTIVE

Contact is able to perform transactions

SUSPENDED

Contact blocked from ordering/purchases but still allowed to make Payments

TERMINATED

Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)

Example:
ACTIVE
account_id
string GUID nullable

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

Example:
2ee0809f-ed91-4b68-b912-5bd6064d602a

Responses

200 200

Successful Request

Body
Object
id
string GUID

The unique identifier of the account

Example:
b560809f-ed91-4b68-b912-5bd6064d602a
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
Activities
POST /activities
PUT /activities/{id}
DELETE /activities/{id}
GET /activities/
GET /activities/{id}
Create Activity
POST /activities

Create a new activity

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

application/json
Object
name
string required

The activity name

Example:
Call customer
description
string nullable

The activity description

Example:
We need to call the contact (after 4pm) in order to schedule a demo
type_id
string GUID required

The activity type (identifier)

Example:
cdd8e232-ddce-87c0-44fd-27f44035a252
address_id
string GUID nullable

The contact address (identifier) associated to the activity

Example:
4d1b276d-6ae9-eca3-8c61-aedd35ebb9a4
use_entity_address
boolean

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

Example:
false
scheduled_on
Object required
from_date
integer epocjh required

The scheduled from date/time

Example:
1592809457
to_date
integer epoch nullable

The scheduled to date/time

Example:
11653396172
linked_to
Array required

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

Example:
[
    {
        "type": "ORDER",
        "id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
    },
    {
        "type": "CONTACT",
        "id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
    }
]
Object
type
string

The type of related entity.

Enumeration:
CONTACT
LEAD
SERVICE_REQUEST
ORDER
id
string GUID

The related entity identifier

Example:
50490788-0f2c-0a73-8ae0-1b129f8fdb50
assign_to
Object nullable
user_id
string GUID

The user identifier

Example:
1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf
team_id
string GUID

The team identifier

Example:
a43f08ca-998b-afbc-6ed4-c9dc2d136935
custom_fields
Array nullable
Object
key
string

The custom field’s unique key

Example:
back_office
value
string

The custom field’s value

Example:
0001-12345

Responses

201 Created

The request has succeded

Body
Object
id
string GUID

The activity identifier

Example:
81b8d150-1196-6e6a-1df9-aaf23adc757d
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
Update Activity
PUT /activities/{id}

Update an existing activity

Path variables

id
string GUID required

The activity (identifier) that will be updated

Example:
43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

application/json
Object
name
string nullable

The activity name

Example:
Approve Offers
description
string nullable

The activity description

Example:
Require 4 approvals for an offer
state
string nullable

The activity state

Enumeration:
PENDING
COMPLETED
CANCELLED
address_id
string GUID nullable

The contact address (identifier) associated to the activity

Example:
6cbe314d-9f32-d3c7-4be6-f453e7b8e77e
scheduled_on
Object nullable
from_date
integer epocjh required

The scheduled from date/time

Example:
1592809457
to_date
integer epoch nullable

The scheduled to date/time

Example:
11653396172
linked_to
Array nullable

The related entities for the activity, contact cannot be updated

Example:
[
    {
        "type": "ORDER",
        "id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
    }
]
Object
type
string required

The type of related entity.

Enumeration:
LEAD
SERVICE_REQUEST
ORDER
id
string GUID required

The related entity identifier

Example:
50490788-0f2c-0a73-8ae0-1b129f8fdb50
assign_to
Object nullable
user_id
string GUID

The user identifier

Example:
1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf
team_id
string GUID

The team identifier

Example:
a43f08ca-998b-afbc-6ed4-c9dc2d136935
custom_fields
Array nullable
Object
key
string

The custom field’s unique key

Example:
back_office
value
string

The custom field’s value

Example:
0001-12345

Responses

200 OK

The request has succeded

Body
Object
id
string GUID

The activity identifier

Example:
43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
Delete Activity
DELETE /activities/{id}

Delete an existing activity

Path variables

id
string GUID required

The activity (identifier) that will be deleted

Example:
52cbb887-a61a-9b1e-63df-1303f7b5718a

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

204 No Content

The request has succeeded

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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 
List Activities
GET /activities/

Retrieve a list of activities based on search criteria (e.g. all open activities)

Request parameters

search_value
string optional

Filter based on search values, such as name (behave as like)

Example:
demo
types
array of string optional

Filter based on activity type(s)

Collection format: csv
contact_id
string GUID optional

Filter based on related contact

Example:
c932ffb1-efe6-b7b3-58c1-a6a86ddcc8d3
service_request_id
string GUID optional

Filter based on related service request

Example:
c932ffb1-efe6-b7b3-58c1-a6a86ddcc822
lead_id
string GUID optional

Filter based on related lead

Example:
c932ffb1-efe6-b7b3-58c1-a6a86ddcc8qq
order_id
string GUID optional

Filter based on related order

Example:
c932ffb1-efe6-b7b3-58c1-a6a86ddcc8d3
states
array of activity state (enum) optional

Filter based on activity state

Collection format: csv
tag_ids
array of string optional

Filter based on activity tags

Collection format: csv
include_tags
boolean optional

Defines whether tags should be retrieved or not

Example:
false
created_on
string optional

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).

Enumeration:
created_on[gt]

Returns results where the created date is greater than this value

created_on[gte]

Returns results where the created date is greater than or equal to this value

created_on[lt]

Returns results where the created date is less than this value

created_on[lte]

Returns results where the created date is less then or equal to this value

completed_on
string optional

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).

Enumeration:
completed_on[gt]

Returns results where the date is greater than this value

completed_on[gte]

Returns results where the date is greater than or equal to this value

completed_on[lt]

Returns results where the date is less than this value

completed_on[lte]

Returns results where the date is less then or equal to this value

assign_to_user_id
string GUID optional

Filters based on specific assign to user

Example:
c45903ff-4a00-49bd-93b4-6b2f0373ce20
assign_to_team_id
string GUID optional

Filters based on specific assign to team

Example:
5beb415c-3246-1a10-f806-3f975e4898dc
custom_fields
string optional

Filters based on custom fields (key/value set should be semicolon separated)

Example:
key;value
include_custom_fields
boolean optional

Defines whether custom fields should be retrieved or not (via List/Get APIs)

Default:
false
Example:
true
sort
string optional

Defines on which attribute the results should be sorted

Default:
CREATED_DATE
Examples:
CREATED_DATEUPDATED_DATENAMESCHEDULED_DATE
order
string optional

Defines how the results will be ordered

Default:
DESC
page
integer optional

The page number that should be retrieved

Default:
1
size
integer optional

The size (total records) of each page

Default:
10

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

200 OK

The request has succeded

Body
Object
content
Array
Object
id
string GUID

The activity identifier

Example:
1cf0d458-b799-1d99-52e4-d7f5081b3c01
name
string

The activity name

Example:
Call customer
description
string

The activity description

Example:
We need to call the customer to arrange a demo
state
string

The activity state

Enumeration:
PENDING
COMPLETED
CANCELLED
key_dates
Object
created_on
integer epoch

The date that the activity was created

Example:
1592809457
scheduled_on
Object

The date/time that the activity is scheduled

from_date
integer epoch

The scheduled from date

Example:
1592809457
to_date
integer epoch

The scheduled to date

Example:
1592809457
type
Object

The activity type

id
string

The activity type identifier

Example:
HGJDHGSJDHG
name
string

The activity type name

Example:
site visit
color
string

The activity type color (hex code), used for visual purposes

Example:
876FD5
contact
Object

Details about the related contact

id
string GUID

The contact identifier

Example:
1c060611-0667-313e-b3bf-4cb70ee81cdf
name
string

The contact full name

Example:
John Doe
code
string

The contact unique code

Example:
C123
lead
Object
id
string GUID

The lead identifier

Example:
2760043d-c671-a428-9b35-2f27b0623fa1
title
string

The lead title

Example:
ASOS
service_request
Object
id
string
Example:
JHGHGF7576HGFTGD564654
number
string
Example:
SRV78001
order
Object
id
string GUID

The order identifier

Example:
2760043d-c671-a428-9b35-2f27b0623fa1
number
string

The order number

Example:
O101367
assign_to
Object
user
Object

Details about the user that the record is assigned to

id
string GUID

The user identifier

Example:
47ac694d-6281-b873-bf46-3fd8da334a3a
name
string

The user name

Example:
John Doe
username
string

The username of the user

Example:
j_doe@crm.com
team
Object

Details about team

id
string GUID

The team identifier

Example:
bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe
name
string

The team name

Example:
Support
custom_fields
Array
Object
key
string

The custom field (unique) key

Example:
back_office
value
string

The custom field’s (provided) value

Example:
Back Office
tags
Object
id
string

Tag unique id

Example:
609a369e-3f10-492a-8332-679ecbe56b65
name
string

Tag name

Example:
Maintenance
colour
string

The colour of the tag

Example:
FR547F
paging
Object
page
integer

The page number

Example:
2
size
integer

The number of records per page

Example:
20
total
integer

The overal number of records

Example:
5124
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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
    }
}
Get Activity
GET /activities/{id}

Retrieve detailed information for an activity

Path variables

id
string GUID required

The activity (identifier) that will be retrieved

Example:
6215f115-321a-c3d4-8809-59ca5f502433

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

200 OK

The request has succeded

Body
Object
id
string GUID

The activity identifier

Example:
6215f115-321a-c3d4-8809-59ca5f502433
name
string

The activity name

Example:
Call customer
description
string

The activity description

Example:
Arrange a call with the customer after 4pm to schedule a demo for next week
key_dates
Object
created_on
integer epoch

The date that the activity was created

Example:
1592809457
scheduled_on
Object

The date/time that the activity is scheduled

from_date
integer epoch

The scheduled from date

Example:
1592809457
to_date
integer epoch

The scheduled to date

Example:
1592809457
type
Object

The activity type

id
string

The activity type identifier

Example:
HGJDHGSJDHG
name
string

The activity type name

Example:
site visit
color
string

The activity type color (hex code), used for visual purposes

Example:
876FD5
contact
Object

Details about the related contact

id
string GUID

The contact identifier

Example:
1c060611-0667-313e-b3bf-4cb70ee81cdf
name
string

The contact full name

Example:
John Doe
code
string

The contact unique code

Example:
C123
service_request
Object
id
string
Example:
JHGHGF7576HGFTGD564654
number
string
Example:
SRV78001
lead
Object
id
string GUID

The lead identifier

Example:
2760043d-c671-a428-9b35-2f27b0623fa1
title
string

The lead title

Example:
ASOS
order
Object
id
string GUID

The order identifier

Example:
2760043d-c671-a428-9b35-2f27b0623fa1
number
string

The order number

Example:
O101367
address
Object
address_line_1
string

The address line 1

Example:
Elia Papakyriakou
address_line_2
string

The address line 2

Example:
7 Tower Stars
state_province_county
string

The address state/province/county

Example:
Egkomi
town_city
string

The address town/city

Example:
Nicosia
postal_code
string

The address postal code

Example:
2015
country
string

The address country (based on ISO 3 char code)

Example:
CYP
lat
number

The latitude of the address

Example:
35.157115
lon
number

The longitude of the address

Example:
33.313719
google_place_id
string

The Google textual identifier that uniquely identifies an address

Example:
ChIJrTLr-GyuEmsRBfy61i59si0
states
Array

The activity states history

Object
state
string

The activity state

Enumeration:
PENDING
COMPLETED
CANCELLED
date
integer epoch

The date on which the state was reached

Example:
1653400142
assign_to
Object
user
Object

Details about the user that the record is assigned to

id
string GUID

The user identifier

Example:
47ac694d-6281-b873-bf46-3fd8da334a3a
name
string

The user name

Example:
John Doe
username
string

The username of the user

Example:
j_doe@crm.com
team
Object

Details about team

id
string GUID

The team identifier

Example:
bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe
name
string

The team name

Example:
Support
custom_fields
Array
Object
key
string

The custom field (unique) key

Example:
back_office
value
string

The custom field’s (provided) value

Example:
Back Office
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
        }
    ]
}
Tags
PUT /activities/{id}/tags
GET /activities/{id}/tags
Update Activity Tags
PUT /activities/{id}/tags

Update the tags associated with the activity

Path variables

id
string GUID required

The activity (identifier) on which tags will be upaded

Example:
d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

application/json
Object
tags
Array required

The tags that will be associated with the activity

string GUID
Example:
96c3cb52-c68f-6ba6-e886-ed28f2b594cb

Responses

200 OK

The request has succeded

Body
Object
id
string GUID

The activity identifier

Example:
d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
}
Get Activity Tags
GET /activities/{id}/tags

Retrieve a list of tags that are associated with the activity

Path variables

id
string GUID required

The activity (identifier) of which tags will be retrieved

Example:
d82881e9-a909-9d44-4f28-4b30fc1ac276

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Responses

200 OK

The request has succeded

Body
application/json
Object
content
Array
Object
id
string GUID

The tag identifier

Example:
1abe9097-d46a-d2ed-3415-fd3e1439d8d4
name
string

The tag name

Example:
VIP
colour
string

The tag color (hex code) that will be used for visual purposes

Example:
#0000FF
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

502 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

503 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

504 Gateway Timeout

The server did not receive a timely response from the upstream server

Example 1
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"
        }
    ]
}
Analytics
GET /organisations/{id}/analytics
GET /contacts/{id}/analytics
Insights
POST /insights
PUT /insights/{id}
DELETE /insights/{id}/
GET /insights
GET /insights/{id}
POST /insights/{id}/events
POST /insights/{id}/filters
POST /insights/{id}/breakdowns
GET /insights/{id}/results
POST /insights/{id}/preview
POST /insights/{id}/exports
Create Insight
POST /insights

Create a new insight

Request headers

authorization
string optional

Authorization Token

Example:
eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
api_key
string optional

The secret api key required for API calls to ensure that the client is trusted

Example:
4dc0809f-ed91-4b68-b912-5bd6064d901e

Request body

Object
name
string required

The insight name

Example:
Marketing customers
description
string nullable

The insight description

Example:
A list of customers that own an account

Responses

200 OK
Body
Object
id
string GUID

The insight identifier

Example:
c0d4712e-6688-4604-b3d6-d084e4d2dc05
200 OK

The request has succeeded

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

401 Unauthorized

The client request has not been completed because it lacks valid authentication credentials for the requested resource

403 Forbidden

The API key or Token does not have permissions to perform the request

404 Not Found

The requested resource does not exist

500 Internal Server Error

The server encountered an unexpected condition which