Download OpenAPI specification:Download
The platform to collect, store, conserve, update and export all the digital identity data of your customers.
The following table provides brief descriptions of the built-in OAuth2 scopes of this API. In this context, scopes are generally intended as application roles.
| Security scheme type: | OAuth2 |
|---|---|
| implicit OAuth Flow | Authorization URL: https://login.contactlab.it/o/oauth2/auth Scopes:
|
Gets count of new, updated and deleted customers
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodes | string The list of nodeId separated by comma |
| startDate | string <date> Start date |
| endDate | string <date> End date |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Trend of customer base
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| mode required | string Default: "DAILY" Enum:"DAILY" "WEEKLY" "MONTHLY" Mode of aggretation daily, weekly,monthly |
| startDate required | string <date> The start date for get the trend |
| endDate required | string <date> The end date for get the trend |
| nodes | string The list of nodeId separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Trend of events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| mode required | string Default: "DAILY" Enum:"DAILY" "WEEKLY" "MONTHLY" Mode of aggretation daily, weekly and monthly |
| startDate required | string <date> The start date for get the trend |
| endDate required | string <date> The end date for get the trend |
| nodes | string The list of nodeId separated by comma |
| context | string Enum:"WEB" "MOBILE" "ECOMMERCE" "RETAIL" "SOCIAL" "DIGITAL_CAMPAIGN" "CONTACT_CENTER" "IOT" "OTHER" The name of event context |
| eventType | string the event type |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets composition by gender for one o multiple node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodes | string The list of nodeId separated by comma |
| startDate | string <date> Start date of the composition |
| endDate | string <date> End date of the composition |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets composition by age range for one o multiple node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodes | string The list of nodeId separated by comma |
| startDate | string <date> Start date of the composition |
| endDate | string <date> End date of the composition |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets composition by country for one o multiple node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodes | string The list of nodeId separated by comma |
| startDate | string <date> Start date of the composition |
| endDate | string <date> End date of the composition |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
GetS composition by city for one o multiple node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| country | string The name of country to filter |
| nodes | string The list of nodeId separated by comma |
| startDate | string <date> Start date of the composition |
| endDate | string <date> End date of the composition |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of new customers, aggregated for nodes.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of new customers, aggregated for nodes and sources.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of new customers, aggregated for nodes and time.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| mode | string Default: "HOUROFDAY" Enum:"HOUROFDAY" "DAYOFWEEK" "DAYOFMONTH" Distribution mode |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of events, aggregated for nodes.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| context | string Enum:"WEB" "MOBILE" "ECOMMERCE" "RETAIL" "SOCIAL" "DIGITAL_CAMPAIGN" "CONTACT_CENTER" "IOT" "OTHER" The name of event context |
| eventType | string Event type |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of events, aggregated for nodes and sources.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| context | string Enum:"WEB" "MOBILE" "ECOMMERCE" "RETAIL" "SOCIAL" "DIGITAL_CAMPAIGN" "CONTACT_CENTER" "IOT" "OTHER" The name of event context |
| eventType | string Event type |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Distribution of events, aggregated for nodes and time.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| context | string Enum:"WEB" "MOBILE" "ECOMMERCE" "RETAIL" "SOCIAL" "DIGITAL_CAMPAIGN" "CONTACT_CENTER" "IOT" "OTHER" The name of event context |
| eventType | string Event type |
| mode | string Default: "HOUROFDAY" Enum:"HOUROFDAY" "DAYOFWEEK" "DAYOFMONTH" Distribution mode |
| startDate | string <date> Start date of the distribution |
| endDate | string <date> End date of the distribution |
| nodes | string List of node identifiers separated by comma |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Analytic customer acquisition distribution.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query required | string Distribution Query object |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Analytic customer distribution.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query required | string Distribution Query object |
| size | integer Distribution size |
| sort | string Distribution sort direction |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Analytic event distribution.
{
"nodeId": "027634e8-5aa1-4436-a543-568f476b3f04",
"startDate": "2015-01-01",
"endDate": "2016-03-31",
"eventType": "completedOrder",
"aggregation": {
"operator": "SUM",
"fieldPath": "properties.products.price"
},
"distributionFieldPath": "properties.products.sku",
"customerDistributionFieldPath": "base.gender"
}
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query required | string Distribution Query object |
| size | integer Distribution size |
| sort | string Distribution sort direction |
| Authorization required | string A valid OAuth2 token |
OK
You don't have the necessary permissions for the resource
Analytic numeric query on events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query | string Numeric Query object |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Analytic trend query on events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query | string Trend Query object |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Analytic distribution query on events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| query | string Distribution Query object |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets all configured automations
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Creates a new automation configuration
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| name | string Automation configuration's name |
| enabled | boolean Flag that specifies if the automation is enabled |
| nodes | Array of string List of nodes |
| delay | integer [ 0 .. 604800 ] Seconds to wait until automation start after triggering |
| topic | object Object that represents a binding with the target event/s |
| tag | object (ActionTagType) Object that represents a "TAG" action |
| webhook | object (ActionWebhookType) Object that represents a "WEBHOOK" action |
Created
Forbidden
Gets a specific automation
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id-automation required | string Unique identifier of automation |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Updates a specific automation
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id-automation required | string Unique identifier of automation |
| Authorization required | string A valid OAuth2 token |
| name | string Automation configuration's name |
| enabled | boolean Flag that specifies if the automation is enabled |
| nodes | Array of string List of nodes |
| delay | integer [ 0 .. 604800 ] Seconds to wait until automation start after triggering |
| topic | object Object that represents a binding with the target event/s |
| tag | object (ActionTagType) Object that represents a "TAG" action |
| webhook | object (ActionWebhookType) Object that represents a "WEBHOOK" action |
OK
Forbidden
Deletes a specific automation
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id-automation required | string Unique identifier of automation |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets workspace parameters
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify workspace parameters
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| name | string name of workspace |
| industry | string Default: "NotDefined" Enum:"GDO" "Luxury" "Automotive" "NotDefined" industry of workspace |
| logo | string url of workspace logo |
| timezone | string Default: "Europe/Rome" Enum:"Europe/Rome" "Europe/Paris" "Europe/London" default timezone of workspace |
| currency | string Default: "EUR" Enum:"EUR" "USD" "JPY" "..." default currency of workspace |
| customerUniquenessPolicy | string Default: "MERGE" Enum:"NO_CHECK" "BLOCK" "MERGE" the customer uniqueness check policy (NO_CHECK, BLOCK, MERGE) |
OK
Forbidden
Gets list of built-in event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets details of built-in event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of event |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Enable/Disable built-in event
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of built-in |
| Authorization required | string A valid OAuth2 token |
| enabled | boolean Default: true flag for enable-disable event |
OK
Forbidden
Gets list of entries node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Creates new entry node
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| name | string the name of entry node |
| description | string the description of entry node |
| imageUrl | string <uri> the url of logo |
| sourcePriority | Array of string array of source |
| mandatoryProperties | Array of string array of mandatory properties |
Created
Forbidden
Gets details of a specific entry node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of entry node |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify a specific entry node
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of entry node |
| Authorization required | string A valid OAuth2 token |
| name | string the name of entry node |
| description | string the description of entry node |
| imageUrl | string <uri> the url of logo |
| sourcePriority | Array of string array of source |
| mandatoryProperties | Array of string array of mandatory properties |
OK
Forbidden
Gets list of view node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Create new view node
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| name | string the name of view node |
| description | string the description of view node |
| imageUrl | string <uri> the url of logo |
Created
Forbidden
Gets details of a specific view node
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of view node |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify a specific view node
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of view node |
| Authorization required | string A valid OAuth2 token |
| name | string the name of view node |
| description | string the description of view node |
| imageUrl | string <uri> the url of logo |
OK
Forbidden
Deletes a specific view node
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of view node |
| Authorization required | string A valid OAuth2 token |
OK
Bad Request
Forbidden
Returns the hierarchy of the tree mapping the workspace organization
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify the hierarchy of the tree mapping the workspace organization
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| tree | object (TreeNode) |
OK
Forbidden
Gets all base properties
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Enable/Disable base properties
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| name required | string The name of base customer property |
| Authorization required | string A valid OAuth2 token |
| name | string the name of base property |
| description | string the description of base property |
| enabled | boolean flag for enable/disable the base property |
OK
Bad Request
Forbidden
Gets extended properties configurated. The json schema of extended
property (including for every elements the contactlabProperties object
with property label, enabled and mergePolicy with value
OBJ_PRIORITY, OBJ_CONCATENATE, ARRAY_UNION, ARRAY_INTERSECTION,
MATH_SUM, MATH_AVG, MATH_DIFF, MATH_MIN, MATH_MAX).
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify extended properties configurated. The json schema of extended
property (including for every elements the contactlabProperties object
with property label, enabled and mergePolicy with value
OBJ_PRIORITY, OBJ_CONCATENATE, ARRAY_UNION, ARRAY_INTERSECTION,
MATH_SUM, MATH_AVG, MATH_DIFF, MATH_MIN, MATH_MAX).
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of source configurated
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Create a new source
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| provider required | string Default: "API" Enum:"API" "JavaScript" "MAGENTO" "CONTACTSEND" "CONTACTPLAN" "ANDROID_SDK" "OBJECTIVEC_SDK" "NODEJS_SDK" "JAVA_SDK" "SCALA_SDK" "DOTNET_SDK" the provider of source |
| name required | string the name of source |
| description | string the description of source |
| properties required | object the properties required by the selected provider |
| nodes required | Array of string list of unique identifier where source is enabled |
| enabled | boolean Default: true flag for enable-disable source |
OK
Forbidden
Gets source details
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of source |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify source
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of source |
| Authorization required | string A valid OAuth2 token |
| provider required | string Default: "API" Enum:"API" "JavaScript" "MAGENTO" "CONTACTSEND" "CONTACTPLAN" "ANDROID_SDK" "OBJECTIVEC_SDK" "NODEJS_SDK" "JAVA_SDK" "SCALA_SDK" "DOTNET_SDK" the provider of source |
| name required | string the name of source |
| description | string the description of source |
| properties required | object the properties required by the selected provider |
| nodes required | Array of string list of unique identifier where source is enabled |
| enabled | boolean Default: true flag for enable-disable source |
| id | string unique identifier of source |
OK
Forbidden
Deletes source
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of source |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Refresh source token
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of source |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets source priority
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies source priority
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| priority | Array of string list of source id ordered by descending priority |
OK
Forbidden
Gets unique customer matching policies for aggregations
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Updates unique customer matching policies for aggregations
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| properties | Array of string Rules of aggregations |
| caseSensitive | boolean Flag that specifies if the matching policy check will be performed considering the field text case. |
OK
Bad Request
Forbidden
Gets users
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets user details
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of user |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modify user nodes
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of user |
| Authorization required | string A valid OAuth2 token |
| nodes required | Array of object |
OK
Forbidden
Gets an operation on consents
Authorizations: | OAuth2 ( DPO) |
| workspaceId required | string The unique identifier of workspace |
| id required | string Identifier of the consent log |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of operations on consents
Authorizations: | OAuth2 ( DPO) |
| workspaceId required | string The unique identifier of workspace |
| customerId | string Identifier of the customer |
| uniqueKey | string The JSON-encoded data structure containing the values of the unique customer |
| startDate | string <date> The date interval lower bound |
| endDate | string <date> The date interval upper bound |
| type | string Enum:"DISCLAIMER_READ" "CONSENT_CHANGED" "CONSENT_RESTRICTED" "CONSENT_OBJECTED" "DATA_PORTABILITY_REQUESTED" "FORCED_DELETE" The type of consent log event |
| property | string Json path of property |
| sort | string Sort field and direction |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of customers
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodeId required | string Identifier of the node where you want to do the search |
| externalId | string The external id assigned to the customers |
| query | string Query for filter the customers |
| fields | string Comma-separated list of properties to include in the response |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Creates a new customer
Authorizations: | OAuth2 ( ADMIN) |
| workspaceId required | string The unique identifier of workspace |
| sessionId | string The unique identifier of session |
| Authorization required | string A valid OAuth2 token |
| externalId | string the external id of customer |
| nodeId required | string entry node |
| base | object base customer data structure included in Contacthub. The model is defined [here] |
| consents | object consents customer data structure included in Contacthub. The model is defined [here] |
| extended | object custom data defined by workspace based on a declarated schema |
| extra | string custom data defined by workspace not based on a declarated schema |
| tags | object the default tags property of customers |
| enabled | boolean flag for soft delete |
Created
Forbidden
Conflict
Reindexing in progress
Gets details of customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies partially the customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| sessionId | string The unique identifier of session |
| Authorization required | string A valid OAuth2 token |
| externalId | string the external id of customer |
| base | object base customer data structure included in Contacthub. The model is defined [here] |
| consents | object consents customer data structure included in Contacthub. The model is defined [here] |
| extended | object custom data defined by workspace based on a declarated schema |
| extra | string custom data defined by workspace not based on a declarated schema |
| tags | object the default tags property of customers |
| enabled | boolean flag for soft delete |
OK
Forbidden
Conflict
Reindexing in progress
Updates customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| sessionId | string The unique identifier of session |
| Authorization required | string A valid OAuth2 token |
| externalId | string the external id of customer |
| nodeId required | string entry node |
| base | object base customer data structure included in Contacthub. The model is defined [here] |
| consents | object consents customer data structure included in Contacthub. The model is defined [here] |
| extended | object custom data defined by workspace based on a declarated schema |
| extra | string custom data defined by workspace not based on a declarated schema |
| tags | object the default tags property of customers |
| enabled | boolean flag for soft delete |
| id | string the customer id |
| sourceInfo | object information about sources that operated on customer |
| registeredAt | string <date-time> the registration timestamp |
| updatedAt | string <date-time> the customer update timestamp |
OK
Forbidden
Conflict
Reindexing in progress
Deletes customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Reindexing in progress
Gets list of raw data from sources
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets raw data from a specific sources
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of customer |
| sourceId required | string The unique identifier of source |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Creates customer education
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of education |
| schoolType | string Enum:"PRIMARY_SCHOOL" "SECONDARY_SCHOOL" "HIGH_SCHOOL" "COLLEGE" "OTHER" The name of school type |
| schoolName | string the name of the school |
| schoolConcentration | string |
| startYear | integer |
| endYear | integer |
| isCurrent | boolean |
OK
Forbidden
Reindexing in progress
Gets details of customer education
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer education |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies customer education
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer education |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of education |
| schoolType | string Enum:"PRIMARY_SCHOOL" "SECONDARY_SCHOOL" "HIGH_SCHOOL" "COLLEGE" "OTHER" The name of school type |
| schoolName | string the name of the school |
| schoolConcentration | string |
| startYear | integer |
| endYear | integer |
| isCurrent | boolean |
OK
Forbidden
Reindexing in progress
Deletes customer education
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer education |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Reindexing in progress
Creates customer like
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of like |
| category | string The name of like category |
| name | string the name of like |
| createdTime | string <date-time> the like creation datetime |
OK
Forbidden
Gets details of customer like
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer like |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies customer like
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer like |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of like |
| category | string The name of like category |
| name | string the name of like |
| createdTime | string <date-time> the like creation datetime |
OK
Forbidden
Reindexing in progress
Deletes customer like
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer like |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Reindexing in progress
Creates customer job
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of job |
| companyIndustry | string The name of company industry |
| companyName | string The name of company |
| jobTitle | string The job title |
| startDate | string <date> job start date |
| endDate | string <date> job end date |
| isCurrent | boolean |
OK
Forbidden
Reindexing in progress
Gets details of customer job
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer job |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies customer job
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer job |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of job |
| companyIndustry | string The name of company industry |
| companyName | string The name of company |
| jobTitle | string The job title |
| startDate | string <date> job start date |
| endDate | string <date> job end date |
| isCurrent | boolean |
OK
Forbidden
Reindexing in progress
Deletes customer job
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer job |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Reindexing in progress
Creates customer subscription
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of subscription |
| name | string The name of subscription |
| type | string The type of subscription |
| kind | string Enum:"DIGITAL_MESSAGE" "SERVICE" "OTHER" The kind of subscription |
| enable | boolean |
| startDate | string <date-time> start date of subscription |
| endDate | string <date-time> end date of subscription |
| subscriberId | string unique identifier of subscriber |
| registeredAt | string <date-time> subscription creation datetime |
| updatedAt | string <date-time> subscription update datetime |
| preferences | Array of object |
Created
Forbidden
Reindexing in progress
Gets details of customer subscription
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer subscription |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies customer subscription
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer subscription |
| Authorization required | string A valid OAuth2 token |
| id | string unique identifier of subscription |
| name | string The name of subscription |
| type | string The type of subscription |
| kind | string Enum:"DIGITAL_MESSAGE" "SERVICE" "OTHER" The kind of subscription |
| enable | boolean |
| startDate | string <date-time> start date of subscription |
| endDate | string <date-time> end date of subscription |
| subscriberId | string unique identifier of subscriber |
| registeredAt | string <date-time> subscription creation datetime |
| updatedAt | string <date-time> subscription update datetime |
| preferences | Array of object |
OK
Forbidden
Reindexing in progress
Deletes customer subscription
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| id required | string The unique identifier of customer subscription |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Reindexing in progress
Gets list of session assign to customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Creates a session of customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| Authorization required | string A valid OAuth2 token |
| value | string the session id of customer. the value is unique for a single node |
Created
Forbidden
Gets a specific sessions assigned at customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| sessionId required | string The unique identifier of session |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Deletes session assigned at customer
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId required | string The unique identifier of customer |
| sessionId required | string The unique identifier of session |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| customerId | string The unique identifier of customer |
| nodeId | string The node identifier |
| type | string One or more event types (separated by comma) |
| context | string One or more event context (separated by comma) |
| mode | string Enum:"ACTIVE" "PASSIVE" the mode of event. ACTIVE if the customer made the event, PASSIVE if the customer recive the event |
| dateFrom | string <date-time> From datetime for search of event |
| dateTo | string <date-time> To datetime for search of event |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Inserts new event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| customerId | string customer id |
| bringBackProperties | object (BringBackProperty) |
| type required | string (EventType) Enum:"abandonedCart" "addedCompare" "addedProduct" "addedWishlist" "campaignBlacklisted" "campaignBounced" "campaignLinkClicked" "campaignMarkedSpam" "campaignOpened" "campaignSent" "campaignSubscribed" "campaignUnsubscribed" "changedSetting" "clickedLink" "closedTicket" "completedOrder" "eventConfirmed" "eventDeclined" "eventEligible" "eventInvited" "eventNoShow" "eventNotInvited" "eventParticipated" "eventRegistered" "formCompiled" "genericActiveEvent" "genericPassiveEvent" "loggedIn" "loggedOut" "openedTicket" "orderShipped" "removedCompare" "removedProduct" "removedWishlist" "repliedTicket" "reviewedProduct" "searched" "serviceSubscribed" "serviceUnsubscribed" "viewedPage" "viewedProduct" "viewedProductCategory" Type of the target event/s |
| context required | string (EventContext) Enum:"WEB" "MOBILE" "ECOMMERCE" "RETAIL" "SOCIAL" "DIGITAL_CAMPAIGN" "CONTACT_CENTER" "IOT" "OTHER" Context of the target event/s |
| date | string <date-time> the timestamp of event |
| contextInfo | object the json schema related to event context. [Read here] |
| tracking | object (Tracking) |
| properties required | object the json schema related to event type. [Read here] |
Accepted
Forbidden
Gets details of specific event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of event |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies details of specific event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of event |
| Authorization required | string A valid OAuth2 token |
The request has been accepted for processing
You don't have the necessary permissions for the resource
Deletes a specific event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The event identifier |
| Authorization required | string A valid OAuth2 token |
No Content
Forbidden
Not Found
Gets base properties. The json schema of base property (including for every elements the contactlabProperties object with property label, enabled.
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of merge policies defined in contacthub
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of providers defined in contacthub
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of event contexts defined in contacthub
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Gets list of segments
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| name | string Query for filter by name the segment |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Inserts a new segment
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| Authorization required | string A valid OAuth2 token |
| name | string name of segment |
| query | object object query |
| enabled | boolean Default: true enable/disable segment |
Created
Forbidden
Details of specific segment
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of segment |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
Modifies a specific segment
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of segment |
| Authorization required | string A valid OAuth2 token |
| name | string name of segment |
| query | object object query |
| enabled | boolean Default: true enable/disable segment |
| id | string id of segment |
OK
Forbidden
Deletes a specific segment
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of segment |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
List of customer in a specific segment. The output it's a list of id. For other property specify with paramenters fields
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| id required | string The unique identifier of segment |
| fields required | string Comma-separated list of properties to include in the response |
| nodeId required | string The identifier of node where you want made the query |
| Authorization required | string A valid OAuth2 token |
OK
Forbidden
get the offset of the last update to any customer or event
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| nodeId | string Filter the entities belonging to this node id |
| entity | string Enum:"CUSTOMER" "EVENT" Filter the entities by type |
| Authorization required | string A valid OAuth2 token |
the offset has been returned
get the stream of updates on customers and events
Authorizations: |
| workspaceId required | string The unique identifier of workspace |
| size | integer [ 0 .. 4000 ] Default: 50 Paging: the page size |
| timestamp | integer The timestamp of the first modified entity; ignored if the |
| offset | integer The greatest offset known by the client (not included in the returned result) |
| nodeId | string Filter the entities belonging to this node id |
| entity | string Enum:"CUSTOMER" "EVENT" Filter the entities by type |
| Authorization required | string A valid OAuth2 token |
Successful response