Skip to main content
API docs by Redocly

Contactplan API (1.77.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