Skip to main content
API docs by Redocly

Contactplan API (1.75.0)

Download OpenAPI specification:Download

Contactplan API

Account

Get account info

Returns all informations about the current account

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string"
}

Get account settings

Returns the settings about the current account

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "preferences": {
    }
}

Modify user settings

Modify settings of the current account

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
required

The account setting resource

userPk
integer <int64>
object (JsonNode)

Responses

Request samples

Content type
application/json
{
  • "userPk": 0,
  • "preferences": {
    }
}

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "preferences": {
    }
}

Datasets

Get a compressed analytics dataset Deprecated

Returns a paged list of results that match with the given query

Authorizations:
OAuth2
path Parameters
statementName
required
string

The name of the statement

query Parameters
planId
string

The UUID of the plan

segmentId
string

The UUID of the segment

format
string
Default: "extended"
Enum: "extended" "compressed"

The format of the response

forceReload
boolean
Default: false

Disable dataset cache. Default value is false (cache enabled)

startDate
string

The begin of date interval

endDate
string

The end of date interval

limit
integer

The maximum number of statements

offset
integer

Offset applied to retrieved statements list before returning the required number of statements

order
string

Sort directions of statements

orderField
string

Sort field of statements

windowTime
string
Enum: "DAY" "MONTH" "QUARTER" "YEAR"

Filter by window time

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "label": "string",
  • "format": "string",
  • "parameters": {
    },
  • "headers": {
    },
  • "data": [
    ]
}

Get a dataset Deprecated

Returns a paged list of results that match with the given query

Authorizations:
OAuth2
path Parameters
statementId
required
string

The UUID of the statement

query Parameters
planId
string

The UUID of the plan

segmentId
string

The UUID of the segment

format
string
Default: "extended"
Enum: "extended" "compressed"

The format of the response

forceReload
boolean
Default: false

Disable dataset cache. Default value is false ( cache disabled )

startDate
string

The begin of date interval

endDate
string

The end of date interval

limit
integer

The maximum number of statements

offset
integer

Offset applied to retrieved statements list before returning the required number of statements

order
string

Sort directions of statements

orderField
string

Sort field of statements

windowTime
string
Enum: "DAY" "MONTH" "QUARTER" "YEAR"

Filter by window time

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "label": "string",
  • "format": "string",
  • "parameters": {
    },
  • "headers": {
    },
  • "data": [
    ]
}

Clab

Get all feedbacks of all plans

Returns all contactlab feedbacks of all plans

Authorizations:
OAuth2
query Parameters
days
integer <int32>
Default: 30

The number of days in the past

includeAll
boolean
Default: false

Include all

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "feedbacks": [
    ]
}

Send a test email campaign Deprecated

Send a test email campaign using the contactlab platform

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The test email campaign resource

identifier
integer <int32>
name
string
modelIdentifier
integer <int32>
senderName
string
senderEmail
string
senderReplyTo
string
selectionId
integer <int32>
filterId
integer <int32>
emails
Array of strings
subject
string
htmlContent
string
textContent
string
removeDuplicates
boolean
Default: false
deferred
boolean
Default: false
payloadValid
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "emails": [
    ],
  • "subject": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "emails": [
    ],
  • "subject": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Send a test email campaign

Send a test email campaign using the contactlab platform

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The test email campaign resource

identifier
integer <int32>
name
string
modelIdentifier
integer <int32>
senderName
string
senderEmail
string
senderReplyTo
string
selectionId
integer <int32>
filterId
integer <int32>
emails
Array of strings
subject
string
htmlContent
string
textContent
string
removeDuplicates
boolean
Default: false
deferred
boolean
Default: false
payloadValid
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "emails": [
    ],
  • "subject": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "emails": [
    ],
  • "subject": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Send a test sms campaign

Send a test sms campaign using the contactlab platform

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The test sms campaign resource

identifier
integer <int32>
name
string
modelIdentifier
integer <int32>
senderName
string
selectionId
integer <int32>
filterId
integer <int32>
phones
Array of strings
textContent
string
removeDuplicates
boolean
Default: false
deferred
boolean
Default: false
payloadValid
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "phones": [
    ],
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "selectionId": 0,
  • "filterId": 0,
  • "phones": [
    ],
  • "textContent": "string",
  • "removeDuplicates": false,
  • "deferred": false,
  • "payloadValid": false
}

Get a feedback

Returns contactlab feedbacks of the specified plan

Authorizations:
OAuth2
path Parameters
planUuid
required
string

The UUID of the plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "deliveryId": 0,
  • "filterId": 0,
  • "filterName": "string",
  • "deliveryName": "string",
  • "deliveryStatus": "string",
  • "subject": "string",
  • "removeDuplicates": false,
  • "newsletter": "string",
  • "bounces": 0,
  • "users": 0,
  • "planificationDate": "string",
  • "test": 0,
  • "medium": 0,
  • "qualifierId": 0,
  • "userDbId": 0,
  • "category": 0,
  • "numDomains": 0,
  • "delivered": 0,
  • "cancelled": 0,
  • "fblComplains": 0,
  • "abuse": 0,
  • "listUnsuscribe": 0,
  • "blacklisted": 0,
  • "temporaryBlacklisted": 0,
  • "errors": 0,
  • "uniqueViews": 0,
  • "views": 0,
  • "hiddenViews": 0,
  • "view_wm": 0,
  • "view_ovu": 0,
  • "view_mobile": 0,
  • "uniqueClicks": 0,
  • "clicks": 0,
  • "uniqueTafClicks": 0,
  • "tafClicks": 0,
  • "unsubscribed": 0,
  • "updates": 0,
  • "blacklisting_temp": 0,
  • "blacklisting_final": 0,
  • "labels": [
    ]
}

Get all test filters

Returns a list of all test filters associated to the database in use, with a default pagination of 15 filters per page sorted by their identifiers

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get a filter

Returns the filter with the given id

Authorizations:
OAuth2
path Parameters
id
required
integer <int32>

The ID of the filter

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "extensions": "string",
  • "identifier": 0,
  • "name": "string",
  • "userDbId": 0,
  • "type": "NORMAL"
}

Post a test filter

Create a new email test filter

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The test email campaign resource

recipients
Array of strings
name
string

Responses

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "content": "string",
  • "extensions": "string",
  • "identifier": 0,
  • "name": "string",
  • "userDbId": 0,
  • "type": "NORMAL"
}

Post a test filter

Create a new sms test filter

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The test email campaign resource

recipients
Array of strings
name
string

Responses

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "content": "string",
  • "extensions": "string",
  • "identifier": 0,
  • "name": "string",
  • "userDbId": 0,
  • "type": "NORMAL"
}

Get all email sending groups

Returns a list of all email sending groups associated to the user database in use

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get a email sending group

Returns a email sending groups with the given id

Authorizations:
OAuth2
path Parameters
id
required
integer <int32>

The ID of the email sending group

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "description": "string",
  • "subject": "string",
  • "charset": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string"
}

Get all sms sending groups

Returns a list of all sms sending groups associated to the user database in use

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ]
}

Get a sms sending group

Returns a sms sending groups with the given id

Authorizations:
OAuth2
path Parameters
id
required
integer <int32>

The ID of the sms sending group

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "identifier": 0,
  • "name": "string",
  • "description": "string",
  • "charset": "string",
  • "textContent": "string",
  • "senderName": "string"
}

Get external informations

Returns every resource created by the specific plan on external systems

Authorizations:
OAuth2
path Parameters
planUuid
required
string

The UUID of the plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "externalEntities": [
    ],
  • "errors": [
    ]
}

Get a plan report

Returns a report for the specified plan with contactlab feedbacks and associated automation

Authorizations:
OAuth2
path Parameters
planUuid
required
string

The UUID of the plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "planUuid": "string",
  • "planName": "string",
  • "planificationDate": "string",
  • "segmentName": "string",
  • "plannedUsers": 0,
  • "planStatus": "string",
  • "user": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updater": "string",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "consumer": "string",
  • "campaignFeedbacks": [
    ],
  • "automationFeedbacks": {
    }
}

Consumers

Get all consumers

Returns a list of consumers

Authorizations:
OAuth2
query Parameters
tenant
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "properties": {
    },
  • "consumer": {
    },
  • "jobs": [
    ]
}

Contacts

Get a contact list Deprecated

Returns a paged list of contacts that match with the given query and (optionally) satisfy the given DND policy for the given planification date

Authorizations:
OAuth2
query Parameters
query
string

Json expression representing the query used to retrieve contacts

attributes
Array of strings

List of contact attributes

resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contact list before returning the required number of contacts

dnd
string

UUID of DND policy to be applied

dndRule
string

Json expression representing the DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Download a contact list

Returns a csv file with paged list of contacts that match with the given query and (optionally) satisfy the given DND policy for the given planification date

Authorizations:
OAuth2
query Parameters
attributes
Array of strings

List of contact attributes

resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>
Default: 10

The maximum number of contacts

offset
integer <int32>
Default: 0

Offset applied to retrieved contact list before returning the required number of contacts

filename
string
Default: "contacts.csv"

Name of match list

dnd
string

UUID of DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
optional

Json expression representing the query used to retrieve contacts

type
required
string
conjunction
string
combinationType
string
queries
Array of objects (QueryRes)
name
string
object (QueryPartRes)
object (CorrelationResObject)
object (QueryPartRes)
object (AnalyticRes)
negative
boolean
Default: false
join
string
queryId
integer <int32>
object (SpecialsInfoRes)
class
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "conjunction": "string",
  • "combinationType": "string",
  • "queries": [
    ],
  • "name": "string",
  • "are": {
    },
  • "correlation": {
    },
  • "did": {
    },
  • "analytic": {
    },
  • "negative": false,
  • "join": "string",
  • "queryId": 0,
  • "specialsInfo": {
    },
  • "class": "string"
}

Response samples

Content type
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get a contact list

Returns a paged list of contacts that match with the given query and (optionally) satisfy the given DND policy for the given planification date

Authorizations:
OAuth2
query Parameters
attributes
Array of strings

List of contact attributes

resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contact list before returning the required number of contacts

dnd
string

UUID of DND policy to be applied

dndRule
string

Json expression representing the DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
optional

Json expression representing the query used to retrieve contacts

type
required
string
conjunction
string
combinationType
string
queries
Array of objects (QueryRes)
name
string
object (QueryPartRes)
object (CorrelationResObject)
object (QueryPartRes)
object (AnalyticRes)
negative
boolean
Default: false
join
string
queryId
integer <int32>
object (SpecialsInfoRes)
class
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "conjunction": "string",
  • "combinationType": "string",
  • "queries": [
    ],
  • "name": "string",
  • "are": {
    },
  • "correlation": {
    },
  • "did": {
    },
  • "analytic": {
    },
  • "negative": false,
  • "join": "string",
  • "queryId": 0,
  • "specialsInfo": {
    },
  • "class": "string"
}

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Get a contact

Returns informations about the contact with the given customer id

Authorizations:
OAuth2
path Parameters
customerId
required
string

Primary key of customer

query Parameters
attributes
Array of strings

List of contact attributes

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Delete a contact

Delete a contact and all the events related by customer id

Authorizations:
OAuth2
path Parameters
customerId
required
string

Primary key of customer

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Events

Download the customer events

Returns a zip file with list of all customer events

Authorizations:
OAuth2
path Parameters
customerId
required
string

Primary key of customer

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Delete the events category

Delete the events with the given category

Authorizations:
OAuth2
path Parameters
category
required
string

Event category

query Parameters
categoryName
required
string

Event category Name

type
string

Event Type

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Plans

Get a list of plans

Return paged plans resource where contact is in associated list

Authorizations:
OAuth2
path Parameters
customerId
required
string

Primary key of customer

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get all plans

Returns a list of plans. A compacted form of plans is returned if request contains a non-empty array of plugins

Authorizations:
OAuth2
query Parameters
status
Array of strings

Array of plan status

start
string

The begin of date interval

end
string

The begin of date interval

name
string

Filter by name

segmentUuid
string

Filter by segment uuid

segmentName
string

Filter by segment name

plugins
Array of strings

Array of plugin identifiers

style
string

If equals to "compact", shows less elements in the response

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
Example
{
  • "page": {
    },
  • "elements": [
    ]
}

Create a plan

Create a plan

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The plan resource

uuid
string
name
string
object (SegmentRes)
object (DndPolicyRes)
excludeDnd
boolean
Default: false
status
string
Enum: "draft" "committed" "archived" "canceled" "error"
locked
boolean
Default: false
object (ScheduleRes)
object or null
object (MaterializationRes)
object (ConstraintsRes)

Contains the strategy, defined by ifNot, to apply if materialization returns a number of contacts less than minContacts or greater than maxContacts

listId
string
cpm
number <double>
authorId
integer <int64>
author
string
createdAt
string <date-time>
updatedAt
string <date-time>
object
workflowStatus
string
Enum: "PREPARATION" "PLAN_CREATED" "PLAN_CREATED_NOTIFIED" "LIST_PREPARATION" "LIST_CREATED" "LIST_NOT_CREATED" "LIST_CREATED_NOTIFIED" "LIST_CONSUMED" "LIST_CONSUMED_NOTIFIED" "DELETE_CONTACT_FROM_LIST" "PLAN_REOPENED_ACCEPTED" "PLAN_REOPENED_NOTIFIED" "PLAN_REOPENED" "PLAN_CANCELED_ACCEPTED" "PLAN_CANCELED_NOTIFIED" "PLAN_CANCELED"
Array of objects (PlanJobRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "properties": {
    },
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Get a plan

Returns a plan with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Modify a plan

Modify a plan with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The plan resource

uuid
string
name
string
object (SegmentRes)
object (DndPolicyRes)
excludeDnd
boolean
Default: false
status
string
Enum: "draft" "committed" "archived" "canceled" "error"
locked
boolean
Default: false
object (ScheduleRes)
object or null
object (MaterializationRes)
object (ConstraintsRes)

Contains the strategy, defined by ifNot, to apply if materialization returns a number of contacts less than minContacts or greater than maxContacts

listId
string
cpm
number <double>
authorId
integer <int64>
author
string
createdAt
string <date-time>
updatedAt
string <date-time>
object
workflowStatus
string
Enum: "PREPARATION" "PLAN_CREATED" "PLAN_CREATED_NOTIFIED" "LIST_PREPARATION" "LIST_CREATED" "LIST_NOT_CREATED" "LIST_CREATED_NOTIFIED" "LIST_CONSUMED" "LIST_CONSUMED_NOTIFIED" "DELETE_CONTACT_FROM_LIST" "PLAN_REOPENED_ACCEPTED" "PLAN_REOPENED_NOTIFIED" "PLAN_REOPENED" "PLAN_CANCELED_ACCEPTED" "PLAN_CANCELED_NOTIFIED" "PLAN_CANCELED"
Array of objects (PlanJobRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "properties": {
    },
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Delete a plan

Delete a plan with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

query Parameters
forced
boolean
Default: true

Force delete archived plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Remove a contact from a plan

Remove a contact from a plan with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

customerId
required
string

Primary key of customer

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Counts the contacts in a plan

Counts the number of contacts in a plan with the given UUID, either in materialized list or in segment (filtered by the dnd rule, if any)

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get plan deliveries

Gets deliveries of plan with the given UUID

path Parameters
uuid
required
string

The UUID of plan

query Parameters
status
string

The deliveries status

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get plan delivery

Gets delivery of plan with the given UUID and the given delivery ID

path Parameters
uuid
required
string

The UUID of plan

id
required
string

The ID of the delivery

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Dashboard

Get all dashboard

Returns a list of dashboards

Authorizations:
OAuth2
query Parameters
limit
integer <int32>

The maximum number of results, Default = -1

offset
integer <int32>

The offset. Default = 0.

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "dashboards": [
    ]
}

Create a dashboard

Returns a dashboard

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dashboard resource

uuid
string
name
string
label
string
description
string
industry
string
Enum: "ECOMMERCE" "FASHION" "MOBILITY" "CONSUMER_GOOD" "FINANCE" "MEDIA_COMM_SPORT" "NO_PROFIT" "TRAVEL" "THIRD_PTY" "OTHER" "PUBLIC_SECTOR" "ALL"
enabled
boolean
Default: false
range
string
Enum: "GLOBAL" "SEGMENT"
Array of objects (WidgetExtendedRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

Delete a dashboard widget

Delete a dashboard widget relationship

Authorizations:
OAuth2
path Parameters
dashboardUuid
required
string

The UUID of the dashboard

widgetUuid
required
string

The UUID of the widget

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get a dashboard

Returns a dashboard

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the dashboard

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

Modify a dashboard

Returns a dashboard

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the dashboard

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dashboard resource

uuid
string
name
string
label
string
description
string
industry
string
Enum: "ECOMMERCE" "FASHION" "MOBILITY" "CONSUMER_GOOD" "FINANCE" "MEDIA_COMM_SPORT" "NO_PROFIT" "TRAVEL" "THIRD_PTY" "OTHER" "PUBLIC_SECTOR" "ALL"
enabled
boolean
Default: false
range
string
Enum: "GLOBAL" "SEGMENT"
Array of objects (WidgetExtendedRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

Delete a dashboard

Delete a dashboard with the given uuid

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the dashboard

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get a dashboard widgets

Returns a list of widgets

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the dashboard

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dashboard widget relationship

Returns a dashboard

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the dashboard

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dashboard widget resource

Array
uuid
string
name
string
label
string
range
string
Enum: "GLOBAL" "SEGMENT"
statement
string
Deprecated
order
integer <int32>
type
string
Enum: "DEMOGRAPHY" "EVENTS" "ATTRIBUTION"
subtype
string
Enum: "CLICK" "OPEN_NO_CLICK" "RECEIVE_NO_OPEN_NO_CLICK" "NO_RECEIVE"
object (GraphRes)
Deprecated
Enum: "analytics-count" "bar-h" "bar" "pie"
kind
string
Enum: "analytics-count" "bar-h" "bar" "pie"
xAxis
string

Label of x axis (if kind is bar or bar-h)

yAxis
string

Label of y axis (if kind is bar or bar-h)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "industry": "ECOMMERCE",
  • "enabled": false,
  • "range": "GLOBAL",
  • "widgets": [
    ]
}

External Contents

Get all active automations

Returns a list of active automations for a range of date

Authorizations:
OAuth2
query Parameters
fromDate
string <date-time>

Filter by automation fromDate before or equal to the specified date

toDate
string <date-time>

The end of date interval

name
string

The automation's name

status
string
Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR"

The automation status (default is COMMITTED, RUNNING, PAUSED)

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get all templates

Returns a list of templates

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get all template pages

Returns a list of template pages

Authorizations:
OAuth2
path Parameters
templateId
required
integer <int32>

The ID of the template

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get page content

Returns a page content

Authorizations:
OAuth2
path Parameters
templateId
required
integer <int32>

The ID of the template

pageId
required
integer <int32>

The number of page

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "templateId": 0,
  • "id": 0,
  • "pageContent": "string",
  • "name": "string"
}

Get information about email designer

If response is true, it's possible use email designer

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Returns the name of the send column that contains

Returns the name of the send column that contains the hub customer id.

Authorizations:
OAuth2
query Parameters
tenant
string

The ID of the tenant

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Template decorator

Decorate given templates with the tracked links

Decorates and replaces all links(with field link.trackRequest=true) in the given templates. The link list have to be in the same order of appearance in the body.

header Parameters
Authorization
required
string
Request Body schema: application/json
required

message template

object (message body)
object (message body)

Responses

Request samples

Content type
application/json
{
  • "bodyHtml": {
    },
  • "bodyText": {
    }
}

Response samples

Content type
application/json
{
  • "bodyHtml": {
    },
  • "bodyText": {
    }
}

Analytics

Retrieves the available Analytic configurations

Retrieves the available Analytics configurations for the current customer.

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "analytics": [
    ]
}

Jobs

Get all jobs

Returns a list of jobs

Authorizations:
OAuth2
query Parameters
tenant
string

The ID of the tenant

includeOrphan
boolean
Default: false

Includes orphan job

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

Launch a single job

Launch a single job with the given tenant ID and plugin UUID

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The job resource

taskId
string
object (TenantRes)
object (PluginRes)
cronExpression
string
object
taskName
string
monitorUuid
string

Responses

Request samples

Content type
application/json
{
  • "taskId": "string",
  • "tenant": {
    },
  • "plugin": {
    },
  • "cronExpression": "string",
  • "properties": {
    },
  • "taskName": "string",
  • "monitorUuid": "string"
}

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "tenant": {
    },
  • "plugin": {
    },
  • "cronExpression": "string",
  • "properties": {
    },
  • "taskName": "string",
  • "monitorUuid": "string"
}

Launch a flow job

Launch a flow job

Authorizations:
OAuth2
query Parameters
tenant
required
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "tenant": {
    },
  • "plugin": {
    },
  • "cronExpression": "string",
  • "properties": {
    },
  • "taskName": "string",
  • "monitorUuid": "string"
}

Get all orphan jobs

Returns a list of orphan jobs

Authorizations:
OAuth2
query Parameters
tenant
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

Get a job

Returns a job with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the job

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "tenant": {
    },
  • "plugin": {
    },
  • "cronExpression": "string",
  • "properties": {
    },
  • "taskName": "string",
  • "monitorUuid": "string"
}

Launch a single job

Launch a single job with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the job

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "tenant": {
    },
  • "plugin": {
    },
  • "cronExpression": "string",
  • "properties": {
    },
  • "taskName": "string",
  • "monitorUuid": "string"
}

Kpis

Get all available kpis

Returns a list of available kpis

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "kpis": [
    ]
}

Get all tenants statistics

Returns statistics about all tenants

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "tenantsStatistics": [
    ]
}

Get all tenants information

Returns informations about all tenants

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "totalTenants": 0,
  • "totalGroupPks": 0,
  • "tenants": [
    ]
}

Get usage kpis

Returns a list of usage kpis about tenants' plans

Authorizations:
OAuth2
query Parameters
tenant
Array of strings

Array of tenant ID

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Get usage kpis

Returns a list of usage kpis about tenants' plans

Authorizations:
OAuth2
query Parameters
tenant
Array of strings

Array of tenant ID

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Scheduled-lists

Get a contact list metadata

Returns a contact list metadata with the given UUID

Authorizations:
OAuth2
path Parameters
listUuid
required
string

The UUID of the list

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "segmentId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "planificationDate": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "materializationAttempts": 0
}

Get list contacts

Returns the contacts contained in the list

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the list

query Parameters
attributes
Array of strings

List of contact attributes

resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contacts list before returning the required number of contacts

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Download a contact list

Returns a csv file with paged list of contacts

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the list

query Parameters
attributes
Array of strings

List of contact attributes

resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

filename
required
string

The name of the file

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contacts list before returning the required number of contacts

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
{
  • "id": 0,
  • "segmentId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "planificationDate": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "materializationAttempts": 0
}

Get a plan lists metadata

Returns a plan list metadata with the given plan UUID

Authorizations:
OAuth2
path Parameters
puid
required
string

The UUID of the plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "segmentId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "planificationDate": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "materializationAttempts": 0
}

User

Get current user info

Returns basic informations about the current user and a list of tenants on which it can operate

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "base": {
    },
  • "extended": {
    }
}

Models

Get all metadata

Returns the metadata

Authorizations:
OAuth2
query Parameters
schema
string

Specify the metadata to read. Available values: events, contacts. If not specified returns all the metadata.

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "events": [
    ]
}

Get base filter meta

Retrieve a list of metadata for every attribute within the base filter

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get contact meta

Return a paged list of metadata for all the attributes of the contact

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "events": [
    ]
}

Set contact attribute to bitmask

Full refresh of attribute bitmask value

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The bitmask resource

attributeName
string
object (ModelAttributeRes)
Array of objects (BitmaskFieldRes)

Responses

Request samples

Content type
application/json
{
  • "attributeName": "string",
  • "attribute": {
    },
  • "bitmaskField": [
    ]
}

Response samples

Content type
application/json
{
  • "attributeName": "string",
  • "attribute": {
    },
  • "bitmaskField": [
    ]
}

Delete contact attribute bitmask values

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

list of value of a specific contact attribute

Return a list of available values for the given attribute

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

query Parameters
parentAttributeValue
string

The parent attribute value

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Gets a value from the LOV of a specific contact attribute given a lov ID

Returns the values of the given contact LOV value

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

lovId
required
string

The ID of lov

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "lovId": "string",
  • "name": "string",
  • "value": "string",
  • "label": "string",
  • "parentValue": "string"
}

Gets metadata for a specific contact attribute

Returns the values of the given contact attribute

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Edits metadata associated to a contact attribute

Returns the modified contact attribute metadata. Only visible, autoinclude, aggregable, label, inputFieldType, displayPosition are modifiable.

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The contact attribute resource. At least one of this properties is required: visible, autoinclude, aggregable, label, inputFieldType, displayPosition.

name
string
description
string
dataType
string
uuid
string
label
string
defaultValue
string
maxValue
number <double>
minValue
number <double>
validationPattern
string
attributeSize
integer <int32>
attributePrecision
integer <int32>
parentAttributeName
string
inputFieldType
string
inputFieldOperators
string
visible
boolean
Default: false
personal
boolean
Default: false
lov
boolean
Default: false
lovLastUpdate
string
validate
boolean
Default: false
validationInclusive
boolean
Default: false
autoinclude
boolean
Default: false
aggregable
boolean
Default: false
inputFieldAggregators
string
lovLocked
boolean
Default: false
cardinality
integer <int32>
heuristicOverride
boolean
Default: false
allowedInputFieldType
string
displayPosition
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Gets a value from the LOV of a specific dimension attribute given a lov ID

Returns the values of the given event LOV value

Authorizations:
OAuth2
path Parameters
attributeName
required
string

The attribute name

lovId
required
string

The ID of lov

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "lovId": "string",
  • "name": "string",
  • "value": "string",
  • "label": "string",
  • "parentValue": "string"
}

Gets metadata for a specific dimension attribute

Return the values for the given dimension attribute

Authorizations:
OAuth2
path Parameters
attributeName
required
string.+

The dimension name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "lovId": "string",
  • "name": "string",
  • "value": "string",
  • "label": "string",
  • "parentValue": "string"
}

Edits metadata associated to a dimension attribute

Returns the modified dimension attribute metadata. Only visible, autoinclude, aggregable, label, inputFieldType, displayPosition are modifiable.

Authorizations:
OAuth2
path Parameters
attributeName
required
string.+

The dimension name

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dimension attribute resource. At least one of this properties is required: visible, autoinclude, aggregable, label, inputFieldType, displayPosition.

name
string
description
string
dataType
string
uuid
string
label
string
defaultValue
string
maxValue
number <double>
minValue
number <double>
validationPattern
string
attributeSize
integer <int32>
attributePrecision
integer <int32>
parentAttributeName
string
inputFieldType
string
inputFieldOperators
string
visible
boolean
Default: false
personal
boolean
Default: false
lov
boolean
Default: false
lovLastUpdate
string
validate
boolean
Default: false
validationInclusive
boolean
Default: false
autoinclude
boolean
Default: false
aggregable
boolean
Default: false
inputFieldAggregators
string
lovLocked
boolean
Default: false
cardinality
integer <int32>
heuristicOverride
boolean
Default: false
allowedInputFieldType
string
displayPosition
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Get all events meta

Return metadata for all the events

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "events": [
    ]
}

Get specific event meta

Return metadata for all events in the given category

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific event meta

Return metadata for the event of specified type in the given category

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

type
required
string

The type of event category

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "type": "string",
  • "description": "string",
  • "label": "string",
  • "idAttibute": "string",
  • "attributes": [
    ],
  • "dimensions": [
    ]
}

Get list of value of a specific event attribute

Return a list of available values for the given attribute

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

type
required
string

The type of event category

attributeName
required
string

The attribute name

query Parameters
parentAttributeValue
string

The parent attribute value

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Gets a value from the LOV of a specific event attribute given a lov ID

Returns the values of the given event LOV value

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

type
required
string

The type of event category

attributeName
required
string

The attribute name

lovId
required
string

The ID of lov

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "lovId": "string",
  • "name": "string",
  • "value": "string",
  • "label": "string",
  • "parentValue": "string"
}

Gets metadata for a specific event attribute

Returns the values of the given event attribute

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

type
required
string

The type of event category

attributeName
required
string.+

The name of attribute

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Edits metadata associated to a event attribute

Returns the modified event attribute metadata. Only visible, autoinclude, aggregable, label, inputFieldType, displayPosition are modifiable.

Authorizations:
OAuth2
path Parameters
category
required
string

The event category

type
required
string

The type of event category

attributeName
required
string.+

The name of attribute

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The event attribute resource. At least one of this properties is required: visible, autoinclude, aggregable, label, inputFieldType, displayPosition.

name
string
description
string
dataType
string
uuid
string
label
string
defaultValue
string
maxValue
number <double>
minValue
number <double>
validationPattern
string
attributeSize
integer <int32>
attributePrecision
integer <int32>
parentAttributeName
string
inputFieldType
string
inputFieldOperators
string
visible
boolean
Default: false
personal
boolean
Default: false
lov
boolean
Default: false
lovLastUpdate
string
validate
boolean
Default: false
validationInclusive
boolean
Default: false
autoinclude
boolean
Default: false
aggregable
boolean
Default: false
inputFieldAggregators
string
lovLocked
boolean
Default: false
cardinality
integer <int32>
heuristicOverride
boolean
Default: false
allowedInputFieldType
string
displayPosition
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataType": "string",
  • "uuid": "string",
  • "label": "string",
  • "defaultValue": "string",
  • "maxValue": 0.1,
  • "minValue": 0.1,
  • "validationPattern": "string",
  • "attributeSize": 0,
  • "attributePrecision": 0,
  • "parentAttributeName": "string",
  • "inputFieldType": "string",
  • "inputFieldOperators": "string",
  • "visible": false,
  • "personal": false,
  • "lov": false,
  • "lovLastUpdate": "string",
  • "validate": false,
  • "validationInclusive": false,
  • "autoinclude": false,
  • "aggregable": false,
  • "inputFieldAggregators": "string",
  • "lovLocked": false,
  • "cardinality": 0,
  • "heuristicOverride": false,
  • "allowedInputFieldType": "string",
  • "displayPosition": 0
}

Get specials query meta

Return a list of metadata for special query available

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "specials": [
    ]
}

Get specials query meta by subtype

Return a list of metadata for special query available filtered by subtype

Authorizations:
OAuth2
path Parameters
subtype
required
string

Subtype of special

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "specials": [
    ]
}

Field distribution

Get field distribution

Returns a list of 20 most common contact attribute values paginated by attribute

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Traces

Get all feedbacks of the loaded data

Returns a list of all the feedbacks of the loaded data

Authorizations:
OAuth2
query Parameters
tenant
required
string

The ID of the tenant

startDate
string

The begin of date interval

endDate
string

The end of date interval

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get the feedback of the loaded data

Return the feedback of the loaded data

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of feedback

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": "CTX_INITIALIZED",
  • "dataLoaderJobs": [
    ]
}

Get all traces from monitor

Returns a list of all the traces from monitor

Authorizations:
OAuth2
query Parameters
limit
integer <int32>
Default: 10

The maximum number of traces

offset
integer <int32>
Default: 0

Offset applied to retrieved trace list before returning the required number of traces

startDate
string

The begin of date interval

endDate
string

The end of date interval

tenant
string

The ID of the tenant

agent
string

The agent info of traces

pclass
string

The process class of traces

pname
string

The process name of traces

pstatus
string

The process status of traces

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "monitors": [
    ]
}

Get a trace from monitor

Returns a trace with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the trace

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "processClass": "string",
  • "processName": "string",
  • "processStatus": "string",
  • "processInfo": "string",
  • "tenantId": "string",
  • "agentInfo": "string",
  • "message": "string",
  • "parentProcessId": "string"
}

Recurrences

Get all recurrences

Returns a list of recurrences

Authorizations:
OAuth2
query Parameters
status
Array of strings

Array of recurrences status

name
string

Filter by name

segmentUuid
string

Filter by segment uuid

segmentName
string

Filter by segment name

plugins
Array of strings

Array of plugin identifiers

style
string

If equals to "compact", shows less elements in the response

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Create a recurrence

Create a recurrence with the given UUID

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The recurrence resource

uuid
string
name
string
object (SegmentRes)
object (DndPolicyRes)
excludeDnd
boolean
Default: false
status
string
Enum: "draft" "committed" "archived" "canceled" "error"
locked
boolean
Default: false
object (ScheduleRes)
object or null
object (MaterializationRes)
object (ConstraintsRes)

Contains the strategy, defined by ifNot, to apply if materialization returns a number of contacts less than minContacts or greater than maxContacts

listId
string
cpm
number <double>
authorId
integer <int64>
author
string
createdAt
string <date-time>
updatedAt
string <date-time>
object
workflowStatus
string
Enum: "PREPARATION" "PLAN_CREATED" "PLAN_CREATED_NOTIFIED" "LIST_PREPARATION" "LIST_CREATED" "LIST_NOT_CREATED" "LIST_CREATED_NOTIFIED" "LIST_CONSUMED" "LIST_CONSUMED_NOTIFIED" "DELETE_CONTACT_FROM_LIST" "PLAN_REOPENED_ACCEPTED" "PLAN_REOPENED_NOTIFIED" "PLAN_REOPENED" "PLAN_CANCELED_ACCEPTED" "PLAN_CANCELED_NOTIFIED" "PLAN_CANCELED"
Array of objects (PlanJobRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "properties": {
    },
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Get a recurrence

Returns a recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Modify a recurrence

Modify a recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The recurrence resource

uuid
string
name
string
object (SegmentRes)
object (DndPolicyRes)
excludeDnd
boolean
Default: false
status
string
Enum: "draft" "committed" "archived" "canceled" "error"
locked
boolean
Default: false
object (ScheduleRes)
object or null
object (MaterializationRes)
object (ConstraintsRes)

Contains the strategy, defined by ifNot, to apply if materialization returns a number of contacts less than minContacts or greater than maxContacts

listId
string
cpm
number <double>
authorId
integer <int64>
author
string
createdAt
string <date-time>
updatedAt
string <date-time>
object
workflowStatus
string
Enum: "PREPARATION" "PLAN_CREATED" "PLAN_CREATED_NOTIFIED" "LIST_PREPARATION" "LIST_CREATED" "LIST_NOT_CREATED" "LIST_CREATED_NOTIFIED" "LIST_CONSUMED" "LIST_CONSUMED_NOTIFIED" "DELETE_CONTACT_FROM_LIST" "PLAN_REOPENED_ACCEPTED" "PLAN_REOPENED_NOTIFIED" "PLAN_REOPENED" "PLAN_CANCELED_ACCEPTED" "PLAN_CANCELED_NOTIFIED" "PLAN_CANCELED"
Array of objects (PlanJobRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "properties": {
    },
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Modify the status of a recurrence

Modify the status of a recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The recurrence resource

status
required
string
Enum: "draft" "committed"

Responses

Request samples

Content type
application/json
{
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Delete a recurrence

Delete a recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

query Parameters
forced
boolean
Default: true

Force delete archived recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "segment": {
    },
  • "dndPolicy": {
    },
  • "excludeDnd": false,
  • "status": "draft",
  • "locked": false,
  • "planification": {
    },
  • "scheduleList": {
    },
  • "materialization": {
    },
  • "constraints": {
    },
  • "listId": "string",
  • "cpm": 0.1,
  • "properties": { },
  • "additionalProperties": "string",
  • "workflowStatus": "PREPARATION",
  • "jobs": [
    ]
}

Get a list of recurrence instances

Returns a list of instances of the recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Plan-jobs

Get recurrence jobs

Returns jobs of recurrence with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of recurrence

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "properties": {
    },
  • "consumer": {
    },
  • "jobs": [
    ]
}

Get plan jobs

Returns jobs of plan with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plan

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "properties": {
    },
  • "consumer": {
    },
  • "jobs": [
    ]
}

Callback

Webhook plan

Altering the state of a plan

path Parameters
planUuid
required
string

The UUID of the plan

consumerUuid
required
string

The UUID of job associated with the plan

header Parameters
Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Plugins

Get all plugins

Returns a list of plugins

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "plugins": [
    ]
}

Get a plugin

Returns a plugin with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of plugin

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "identifier": "string",
  • "type": "string",
  • "category": "string",
  • "properties": {
    },
  • "label": "string",
  • "description": "string"
}

Dnd-policies

Get all the dnd policies

Returns a list of dnd policies

Authorizations:
OAuth2
query Parameters
limit
integer <int32>

The maximum number of dnd policies, -1 for all

offset
integer <int32>

Offset applied to retrieved dnd policy list before returning the required number of dnd policies

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "dndPolicies": [
    ]
}

Create a dnd policy

Create a dnd policy

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dnd policy resource

uuid
string
name
string
object (Rule)
applyByDefault
boolean
Default: false
isGlobal
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "rule": {
    },
  • "applyByDefault": false,
  • "isGlobal": false
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "rule": {
    },
  • "applyByDefault": false,
  • "isGlobal": false
}

Get a dnd policy

Returns a dnd policy with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of dnd policy

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "rule": {
    },
  • "applyByDefault": false,
  • "isGlobal": false
}

Modify a dnd policy

Modify a dnd policy with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of dnd policy

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The dnd policy resource

uuid
string
name
string
object (Rule)
applyByDefault
boolean
Default: false
isGlobal
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "rule": {
    },
  • "applyByDefault": false,
  • "isGlobal": false
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "rule": {
    },
  • "applyByDefault": false,
  • "isGlobal": false
}

Delete a dnd policy

Delete a dnd policy with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of dnd policy

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Rules

Get all rules

Returns a list of rules

Authorizations:
OAuth2
query Parameters
limit
integer <int32>

The maximum number of rules

category
string

The category of the rules

offset
integer <int32>

Offset applied to retrieved rules list before returning the required number of rules

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Create a rule

Create a rule

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The rule resource

name
required
string
category
required
string
group
required
string
required
object (QueryRes)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Get a rule

Returns the rule with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of rule

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Modify a rule

Modify the rule with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of rule

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The rule resource

name
required
string
category
required
string
group
required
string
required
object (QueryRes)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Delete rule

Delete the rule with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of rule

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get rule contacts

Return the contacts contained in the rule

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of rule

query Parameters
resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contacts list before returning the required number of contacts

attributes
Array of strings

List of contact attributes

dnd
string

UUID of DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. Required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Download a contact list

Returns a csv file with paged list of contacts that match with the given rule query and (optionally) satisfy the given DND policy for the given planification date

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of rule

query Parameters
resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of contacts

offset
integer <int32>

Offset applied to retrieved contacts list before returning the required number of contacts

attributes
Array of strings

List of contact attributes

dnd
string

UUID of DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. Required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "category": "string",
  • "group": "string",
  • "query": {
    }
}

Segments

Get all segments

Returns a list of segments

Authorizations:
OAuth2
query Parameters
page
string

The page number of segments list

limit
integer <int32>

The maximum number of segments

offset
integer <int32>

Offset applied to retrieved segments list before returning the required number of segments

name
string

Filter by name

type
string
Enum: "ALL" "COMBINED" "SIMPLE"

Filter by type

style
string

If equals to "compact", shows less elements in the response

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Create segment

Create a segment

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
optional
uuid
string
name
string
object (QueryRes)
combined
boolean
Default: false
editable
boolean
Default: false
deleted
boolean
Default: false
object (CombinedSegmentRes)
Array of objects (SegmentBaseInfoRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Create a combined segment Deprecated

Create a combined segment

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
optional
operators
Array of strings
Array of objects (SegmentBaseInfoRes)
name
string

Responses

Request samples

Content type
application/json
{
  • "operators": [
    ],
  • "segments": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Get combined segment contacts

Return the contacts contained in the combined segment

Authorizations:
OAuth2
query Parameters
resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of segments

offset
integer <int32>

Offset applied to retrieved segments list before returning the required number of segments

attributes
Array of strings

List of contact attributes

dnd
string

UUID of DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. Required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
optional
operators
Array of strings
Array of objects (SegmentBaseInfoRes)

Responses

Request samples

Content type
application/json
{
  • "operators": [
    ],
  • "segments": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Get a segment

Returns the segment with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Modify segment

Modify a segment with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The segment resource

uuid
string
name
string
object (QueryRes)
combined
boolean
Default: false
editable
boolean
Default: false
deleted
boolean
Default: false
object (CombinedSegmentRes)
Array of objects (SegmentBaseInfoRes)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "name": "string",
  • "query": {
    },
  • "combined": false,
  • "editable": false,
  • "deleted": false,
  • "uses": {
    },
  • "usedBy": [
    ]
}

Delete segment

Delete a segment with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get segment contacts

Return the contacts contained in the segment

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

query Parameters
resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of segments

offset
integer <int32>

Offset applied to retrieved segments list before returning the required number of segments

attributes
Array of strings

List of contact attributes

dnd
string

UUID of DND policy to be applied

dndRule
string

Json expression representing the DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. Required for DND policy evaluation

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "results": [
    ],
  • "hits": 0,
  • "pagination": {
    }
}

Download a contact list

Returns a csv file with paged list of contacts that match with the given segment query and (optionally) satisfy the given DND policy for the given planification date

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

query Parameters
resultType
string

Result can be hits (count is returned), list (contacts id and email are returned), partial_list (only defined attributes are returned), full_list (all attributes are returned)

limit
integer <int32>

The maximum number of segments

offset
integer <int32>

Offset applied to retrieved segments list before returning the required number of segments

attributes
Array of strings

List of contact attributes

dnd
string

UUID of DND policy to be applied

planificationDate
string

Target date in which contacts will be used for a marketing action. Required for DND policy evaluation

filename
string
Default: "contacts.csv"

Name of match list

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get all shared segment operations

Return all the shared segment operations for the segment

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "shared": [
    ]
}

Share a new segment operations

Share a new operation for the segment

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the segment

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The share resource

required
Array of objects (TenantShareSegmentRes)
Array
id
required
integer

tenant id

Responses

Request samples

Content type
application/json
{
  • "tenants": [
    ]
}

Response samples

Content type
application/json
{
  • "authorId": 0,
  • "author": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updaterId": 0,
  • "updater": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "requestUuid": "string",
  • "tenants": [
    ]
}

Statements

Get all statement

Returns a list of statements

Authorizations:
OAuth2
query Parameters
limit
integer <int32>
Default: -1

The maximum number of statements

offset
integer <int32>
Default: 0

Offset applied to retrieved statement list before returning the required number of statements

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "statements": [
    ]
}

Creates a statement

Returns a statement

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The statement resource

uuid
string
name
string
label
string
type
string
Enum: "GLOBAL" "SEGMENT"
query
string
public
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "type": "GLOBAL",
  • "query": "string",
  • "public": false
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "type": "GLOBAL",
  • "query": "string",
  • "public": false
}

Get a statement

Returns a statement with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the statement

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "statements": [
    ]
}

Modify a statement

Modify a statement with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the statement

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The statement resource

uuid
string
name
string
label
string
type
string
Enum: "GLOBAL" "SEGMENT"
query
string
public
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "type": "GLOBAL",
  • "query": "string",
  • "public": false
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "type": "GLOBAL",
  • "query": "string",
  • "public": false
}

Delete a statement

Delete a statement with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of the statement

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Tenants

Get a tenant configuration

Returns a tenant configuration

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "defaultUtcOffset": 0,
  • "defaultRegion": "string",
  • "defaultLocale": "string",
  • "defaultFirstDayOfWeek": 0,
  • "alertEmail": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "tenantLabel": "string",
  • "groupName": "string",
  • "groupPk": 0,
  • "userDbId": "string",
  • "idAttribute": "string",
  • "mailAttribute": "string",
  • "smsAttribute": "string",
  • "hubIdAttribute": "string",
  • "timeSeriesDashboard": true,
  • "enableShareSegment": true,
  • "planRetentionMonths": 0,
  • "workspaceId": "string"
}

Get all tenants

If groupPk is not provided, returns all tenants. Otherwise, returns either the tenant custom configuration for each tenant owned by groupPk (if type is extended), or the list of tenants owned by groupPk (if type is collapsed)

Authorizations:
OAuth2
query Parameters
groupPk
integer <int64>

Group pk of tenant

type
string
Default: "extended"
Enum: "extended" "collapsed"

The type of response

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
Example
{
  • "_embedded": {
    }
}

Modify tenant

Modify the tenant with the given group pk and user db id

Authorizations:
OAuth2
query Parameters
groupPk
required
string

Group pk of tenant

userDbId
required
string

Users database ID of tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
required

The configuration resource

object (BaseConfig)
customerId
integer <int64>
userDbId
integer <int64>
updatedBy
integer <int64>
object (ConfigLink)
object (PlanCustomConfigProperties)

Responses

Request samples

Content type
application/json
{
  • "base": {
    },
  • "customerId": 0,
  • "userDbId": 0,
  • "updatedBy": 0,
  • "_links": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "base": {
    },
  • "customerId": 0,
  • "userDbId": 0,
  • "updatedBy": 0,
  • "_links": {
    },
  • "properties": {
    }
}

Create tenant

Create the tenant with the given configuration

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
required

The configuration resource

object (BaseConfig)
customerId
integer <int64>
userDbId
integer <int64>
updatedBy
integer <int64>
object (ConfigLink)
object (PlanCustomConfigProperties)

Responses

Request samples

Content type
application/json
{
  • "base": {
    },
  • "customerId": 0,
  • "userDbId": 0,
  • "updatedBy": 0,
  • "_links": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "base": {
    },
  • "customerId": 0,
  • "userDbId": 0,
  • "updatedBy": 0,
  • "_links": {
    },
  • "properties": {
    }
}

Delete tenant

Delete the tenant with the given group pk and user db id

Authorizations:
OAuth2
query Parameters
groupPk
required
string

Group pk of tenant

userDbId
required
string

Users database ID of tenant

force
boolean
Default: false

Forced delete tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get all tenant users

Returns all tenant users

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Modify tenant settings

Modify the settings of tenant with the given tenant ID

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
optional

The settings tenant resource

defaultUtcOffset
required
integer <int32>
defaultRegion
string
defaultLocale
required
string
defaultFirstDayOfWeek
required
integer <int32>
alertEmail
string

email for job failure notification

Responses

Request samples

Content type
application/json
{
  • "defaultUtcOffset": 0,
  • "defaultRegion": "string",
  • "defaultLocale": "string",
  • "defaultFirstDayOfWeek": 0,
  • "alertEmail": "string"
}

Response samples

Content type
application/json
{
  • "defaultUtcOffset": 0,
  • "defaultRegion": "string",
  • "defaultLocale": "string",
  • "defaultFirstDayOfWeek": 0,
  • "alertEmail": "string"
}

Get tenant base filter

Get the base filter of tenant with the given tenant ID

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "conjunction": "and",
  • "applyBlacklist": true,
  • "conditions": [
    ]
}

Modify tenant base filter

Modify the base filter of tenant with the given tenant ID

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the tenant

header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
optional

The base filter tenant resource

conjunction
required
string
Enum: "and" "or"
applyBlacklist
required
boolean
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "conjunction": "and",
  • "applyBlacklist": true,
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "conjunction": "and",
  • "applyBlacklist": true,
  • "conditions": [
    ]
}

FeatureFlag

Get workspace and node with feature flag 'importHubCustomer' enabled

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get feature flag for tenant by groupPk and userDbId

Authorizations:
OAuth2
path Parameters
groupPk
required
integer

The groupPk

userDbId
required
integer

The userDbId

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{ }

Utilities

Get all scheduled recurrence

Returns a list scheduled recurrence

Authorizations:
OAuth2
query Parameters
recurrence
required
string

The recurrence resource

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "planifications": [
    ]
}

Get all heuristic rules

Returns a list of heuristic rules

Authorizations:
OAuth2
query Parameters
type
string

Type of heuristic rule

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Widgets

Get all widgets

Returns a list of widgets, sorted by their "order" value

Authorizations:
OAuth2
query Parameters
range
string
Enum: "GLOBAL" "SEGMENT"
type
string
Enum: "DEMOGRAPHY" "EVENTS" "ATTRIBUTION"
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a widget

Returns a widget

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The widget resource

uuid
string
name
string
label
string
range
string
Enum: "GLOBAL" "SEGMENT"
statement
string
Deprecated
order
integer <int32>
type
string
Enum: "DEMOGRAPHY" "EVENTS" "ATTRIBUTION"
subtype
string
Enum: "CLICK" "OPEN_NO_CLICK" "RECEIVE_NO_OPEN_NO_CLICK" "NO_RECEIVE"
object (GraphRes)
Deprecated
Enum: "analytics-count" "bar-h" "bar" "pie"
kind
string
Enum: "analytics-count" "bar-h" "bar" "pie"
xAxis
string

Label of x axis (if kind is bar or bar-h)

yAxis
string

Label of y axis (if kind is bar or bar-h)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "range": "GLOBAL",
  • "statement": "string",
  • "order": 0,
  • "type": "DEMOGRAPHY",
  • "subtype": "CLICK",
  • "graph": "analytics-count",
  • "kind": "analytics-count",
  • "xAxis": "string",
  • "yAxis": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "range": "GLOBAL",
  • "statement": "string",
  • "order": 0,
  • "type": "DEMOGRAPHY",
  • "subtype": "CLICK",
  • "graph": "analytics-count",
  • "kind": "analytics-count",
  • "xAxis": "string",
  • "yAxis": "string"
}

Get a widget

Returns a widget and the dataset associated to its statement

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of widget

query Parameters
segmentId
string

The UUID of a segment to query for the dataset

forceReload
boolean
Default: false

Disable dataset cache. Default value is false (cache enabled)

startDate
string <date-time>
Default: "0000-01-01T00:00:00Z"

The begin of date interval for the dataset

endDate
string <date-time>
Default: "9999-01-01T00:00:00Z"

The end of date interval for the dataset

deliveryId
integer

The delivery ID to query for the dataset

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "range": "GLOBAL",
  • "statement": "string",
  • "order": 0,
  • "type": "DEMOGRAPHY",
  • "subtype": "CLICK",
  • "graph": "analytics-count",
  • "kind": "analytics-count",
  • "xAxis": "string",
  • "yAxis": "string",
  • "data": {
    },
  • "timeseries": "DAILY"
}

Modify a widget

Returns a widget with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of widget

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The widget resource

uuid
string
name
string
label
string
range
string
Enum: "GLOBAL" "SEGMENT"
statement
string
Deprecated
order
integer <int32>
type
string
Enum: "DEMOGRAPHY" "EVENTS" "ATTRIBUTION"
subtype
string
Enum: "CLICK" "OPEN_NO_CLICK" "RECEIVE_NO_OPEN_NO_CLICK" "NO_RECEIVE"
object (GraphRes)
Deprecated
Enum: "analytics-count" "bar-h" "bar" "pie"
kind
string
Enum: "analytics-count" "bar-h" "bar" "pie"
xAxis
string

Label of x axis (if kind is bar or bar-h)

yAxis
string

Label of y axis (if kind is bar or bar-h)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "range": "GLOBAL",
  • "statement": "string",
  • "order": 0,
  • "type": "DEMOGRAPHY",
  • "subtype": "CLICK",
  • "graph": "analytics-count",
  • "kind": "analytics-count",
  • "xAxis": "string",
  • "yAxis": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "label": "string",
  • "range": "GLOBAL",
  • "statement": "string",
  • "order": 0,
  • "type": "DEMOGRAPHY",
  • "subtype": "CLICK",
  • "graph": "analytics-count",
  • "kind": "analytics-count",
  • "xAxis": "string",
  • "yAxis": "string"
}

Delete a widget

Delete a widget with the given UUID

Authorizations:
OAuth2
path Parameters
uuid
required
string

The UUID of widget

header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string",
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

WidgetStatementAttributes

Get all widget statement attributes

Get all widget statement attributes used to build statements

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ]
}

Patch widget statement attributes

Modify model attribute name of one or more widget statement attributes used to build statements

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Tenant
required
integer

The ID of the tenant to operate on

Request Body schema: application/json
required

The widget statement attributes to modify

Array of objects (WidgetStatementAttributeRes)
Array
widgetKey
string
modelAttributeName
string
widgetKeyDescription
string

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": [
    ]
}