Skip to main content
API docs by Redocly

Contactflow API (2.49.0)

Download OpenAPI specification:Download

Contactflow API

User

Get current user info

Returns basic informations about the current user and a list of nodes 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": {
    }
}

Actions

Get avaible actions for node

Return the avaible actions of a node

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
[
  • "CLAB_CAMPAIGN_SMS"
]

Nodes

Get all nodes

Returns all available nodes for the current user

Authorizations:
OAuth2
query Parameters
portfolioUuid
string <uuid>

Filter nodes by portfolio

workspaceUuid
string <uuid>

Filter nodes by workspace

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

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

Create a node

Handles node provisioning

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
required

The node resource

uuid
string <uuid>
name
string
workspaceUuid
string <uuid>
workspaceName
string
portfolioUuid
string <uuid>
portfolioName
string
groupPk
integer <int64>
userdbId
integer <int64>
groupName
string
active
boolean
emailActive
boolean
smsActive
boolean
created
string <date-time>
hubPhoneField
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "workspaceUuid": "440374de-d1f6-4e58-8880-bb86654d7756",
  • "workspaceName": "string",
  • "portfolioUuid": "734e4f25-f179-406a-bdfa-12cd4a997014",
  • "portfolioName": "string",
  • "groupPk": 0,
  • "userdbId": 0,
  • "groupName": "string",
  • "active": true,
  • "emailActive": true,
  • "smsActive": true,
  • "created": "2019-08-24T14:15:22Z",
  • "hubPhoneField": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "workspaceUuid": "440374de-d1f6-4e58-8880-bb86654d7756",
  • "workspaceName": "string",
  • "portfolioUuid": "734e4f25-f179-406a-bdfa-12cd4a997014",
  • "portfolioName": "string",
  • "groupPk": 0,
  • "userdbId": 0,
  • "groupName": "string",
  • "active": true,
  • "emailActive": true,
  • "smsActive": true,
  • "created": "2019-08-24T14:15:22Z",
  • "hubPhoneField": "string"
}

Get a node

Returns the node with the given UUID

Authorizations:
OAuth2
path Parameters
nodeUuid
required
string <uuid>

The UUID of the node

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "workspaceUuid": "440374de-d1f6-4e58-8880-bb86654d7756",
  • "workspaceName": "string",
  • "portfolioUuid": "734e4f25-f179-406a-bdfa-12cd4a997014",
  • "portfolioName": "string",
  • "groupPk": 0,
  • "userdbId": 0,
  • "groupName": "string",
  • "active": true,
  • "emailActive": true,
  • "smsActive": true,
  • "created": "2019-08-24T14:15:22Z",
  • "hubPhoneField": "string"
}

Delete a node

Deletes the node with the given UUID

Authorizations:
OAuth2
path Parameters
nodeUuid
required
string <uuid>

The UUID of the node

header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Update a node

Enables or disables a node, sms, email service by setting their active property. Updates hubPhoneField used for sms service. A disabled node is in a "logical deletion" status, which means it is not operational, not usable or visible.

Authorizations:
OAuth2
path Parameters
nodeUuid
required
string <uuid>

The UUID of the node

header Parameters
Authorization
required
string

A valid OAuth2 token

Request Body schema: application/json
required

The property of the node resource

active
required
boolean
smsActive
boolean
emailActive
boolean
hubPhoneField
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "smsActive": true,
  • "emailActive": true,
  • "hubPhoneField": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "workspaceUuid": "440374de-d1f6-4e58-8880-bb86654d7756",
  • "workspaceName": "string",
  • "portfolioUuid": "734e4f25-f179-406a-bdfa-12cd4a997014",
  • "portfolioName": "string",
  • "groupPk": 0,
  • "userdbId": 0,
  • "groupName": "string",
  • "active": true,
  • "emailActive": true,
  • "smsActive": true,
  • "created": "2019-08-24T14:15:22Z",
  • "hubPhoneField": "string"
}

Node Settings

Get all settings

Returns all settings for the specified node

Authorizations:
OAuth2
query Parameters
Category
string
Value: "INTEGRATION"

Filter by category

Type
string
Value: "CLAB_API_SOAP"

Filter by type

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Add a setting

Adds a setting to the specified node

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The setting to add

uuid
string <uuid>
label
string
category
string
Value: "INTEGRATION"
type
string
Enum: "CLAB_API_SOAP" "HUB"
value
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "label": "string",
  • "category": "INTEGRATION",
  • "type": "CLAB_API_SOAP",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "label": "string",
  • "category": "INTEGRATION",
  • "type": "CLAB_API_SOAP",
  • "value": { }
}

Get a setting

Returns the setting with the specified UUID

Authorizations:
OAuth2
path Parameters
settingUuid
required
string <uuid>

The UUID of the setting

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "label": "string",
  • "category": "INTEGRATION",
  • "type": "CLAB_API_SOAP",
  • "value": { }
}

Update a setting

Updates the setting with the specified UUID

Authorizations:
OAuth2
path Parameters
settingUuid
required
string <uuid>

The UUID of the setting

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The setting resource

uuid
string <uuid>
label
string
category
string
Value: "INTEGRATION"
type
string
Enum: "CLAB_API_SOAP" "HUB"
value
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "label": "string",
  • "category": "INTEGRATION",
  • "type": "CLAB_API_SOAP",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "label": "string",
  • "category": "INTEGRATION",
  • "type": "CLAB_API_SOAP",
  • "value": { }
}

Delete a setting

Deletes the setting with the specified UUID

Authorizations:
OAuth2
path Parameters
settingUuid
required
string <uuid>

The UUID of the setting

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Automations

Get all automations

Returns all available automations

Authorizations:
OAuth2
query Parameters
name
string

Filter by name

description
string

Filter by description

status
Array of strings
Items Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR" "TO_ARCHIVE"

Filter by one or more statuses

category
Array of strings
Items Value: "Custom"

Filter by one or more categories

startDateBefore
string <date-time>

Filter by automation startDate before or equal to the specified date

startDateAfter
string <date-time>

Filter by automation start date after or equal to the specified date

endDateBefore
string <date-time>

Filter by automation end date before or equal to the specified date

endDateAfter
string <date-time>

Filter by automation end date after or equal to the specified date

createdBefore
string <date-time>

Filter by automation creation date before or equal to the specified date

createdAfter
string <date-time>

Filter by automation creation date after or equal to the specified date

style
string

If equals compact, show less element in response

stepType
string
Enum: "CLAB_CAMPAIGN_SMS" "CLAB_CAMPAIGN" "WEBHOOK" "TAG" "FROM_LAST_STEP" "WAIT_AND_CHECK" "WAIT_FOR_TRIGGER" "AB_TEST" "NO_ACTION"

Filter automation by action type

hasTrigger
boolean
Default: false

Filter automation that have real time source

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Create an automation

Creates an automation

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The automation resource

uuid
string <uuid>
name
string
category
string (AutomationCategory)
Value: "Custom"
author
string
startDate
string <date-time>
timezone
string
status
string (AutomationStatus)
Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR" "TO_ARCHIVE" "TO_DELETE"
created
string <date-time>
createdBy
string
description
string
endDate
string <date-time>
uniqueToken
boolean
Default: false

Set this to discard duplicated token

removeActionPrimary
boolean
Default: false

It is valid only for real time source when INSERT CUSTOMER ACTION and REMOVE CUSTOMER ACTION have same conditions. It specifies if REMOVE CUSTOMER ACTION has priority.

sourceDescription
string

Description of source

Array of objects
Array of objects (Step)
Array of objects (Connection)
object (AutomationStatistics)

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Get an automation

Returns the automation with the given UUID

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Update an automation

Updates the automation with the given UUID

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

query Parameters
removeExpiredCustomers
boolean
Default: false

Specifies whether all the expired customers must be removed before updating the automation. This flag has effect if and only if the automation must change its status from PAUSED to RUNNING.

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The automation resource

uuid
string <uuid>
name
string
category
string (AutomationCategory)
Value: "Custom"
author
string
startDate
string <date-time>
timezone
string
status
string (AutomationStatus)
Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR" "TO_ARCHIVE" "TO_DELETE"
created
string <date-time>
createdBy
string
description
string
endDate
string <date-time>
uniqueToken
boolean
Default: false

Set this to discard duplicated token

removeActionPrimary
boolean
Default: false

It is valid only for real time source when INSERT CUSTOMER ACTION and REMOVE CUSTOMER ACTION have same conditions. It specifies if REMOVE CUSTOMER ACTION has priority.

sourceDescription
string

Description of source

Array of objects
Array of objects (Step)
Array of objects (Connection)
object (AutomationStatistics)

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Update an automation status and name

Updates the automation status with the given UUID and status

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

query Parameters
removeExpiredCustomers
boolean
Default: false

Specifies whether all the expired customers must be removed before updating the automation. This flag has effect if and only if the automation must change its status from PAUSED to RUNNING.

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The automation resource

name
string
status
string (AutomationStatus)
Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR" "TO_ARCHIVE" "TO_DELETE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "COMMITTED"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "category": "Custom",
  • "author": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "timezone": "string",
  • "status": "COMMITTED",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "description": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "uniqueToken": false,
  • "removeActionPrimary": false,
  • "sourceDescription": "string",
  • "triggerEvents": [
    ],
  • "steps": [
    ],
  • "connections": [
    ],
  • "statistics": {
    }
}

Delete an automation

Deletes the automation with the given UUID

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Get feedbacks for a step

Returns the feedbacks for the step eith the given UUID

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

stepUuid
required
string <uuid>

The UUID of the step

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "type": "ACTION",
  • "operation": "CLAB_CAMPAIGN_SMS",
  • "description": "string",
  • "feedbacks": {
    }
}

Get feedbacks for an automation

Returns the feedbacks for the automation with the given UUID

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "automationUuid": "string",
  • "steps": [
    ]
}

Get reports for all Automations

Returns reports for all Automations in a CSV file

Authorizations:
OAuth2
query Parameters
automationUuid
string <uuid>

The UUID of the automation

name
string

Filter by automation name

description
string

Filter by automation description

status
Array of strings
Items Enum: "COMMITTED" "PAUSED" "RUNNING" "ARCHIVED" "DRAFT" "ERROR"

Filter by one or more status

category
Array of strings
Items Value: "Custom"

Filter by one or more categories

startDateBefore
string <date-time>

Filter by automation startDate before or equal to the specified date

startDateAfter
string <date-time>

Filter by automation start date after or equal to the specified date

endDateBefore
string <date-time>

Filter by automation end date before or equal to the specified date

endDateAfter
string <date-time>

Filter by automation end date after or equal to the specified date

createdBefore
string <date-time>

Filter by automation creation date before or equal to the specified date

createdAfter
string <date-time>

Filter by automation creation date after or equal to the specified date

filename
string
Default: "feedbacks"

filename

stepType
string
Enum: "CLAB_CAMPAIGN" "CLAB_CAMPAIGN_SMS" "FROM_LAST_STEP" "WAIT_AND_CHECK" "WAIT_FOR_TRIGGER" "AB_TEST" "NO_ACTION"

Filter automation by action type

hasTrigger
boolean
Default: false

Filter automation that have real time source

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Get automation categories Deprecated

Returns all available automation categories

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Customers

Add a customer to an automation

Adds a customer to the specified automation

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The customer to add

uuid
string <uuid>
userPk
string
clabUuid
string <uuid>
object
automationUuid
string <uuid>
automationName
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "userPk": "string",
  • "clabUuid": "8cbf0f5e-0020-4bd6-8925-9d4b777708ec",
  • "attributes": {
    },
  • "automationUuid": "37d046c1-2b04-4489-aa44-3e7a9ef5bf6c",
  • "automationName": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "userPk": "string",
  • "clabUuid": "8cbf0f5e-0020-4bd6-8925-9d4b777708ec",
  • "attributes": {
    },
  • "automationUuid": "37d046c1-2b04-4489-aa44-3e7a9ef5bf6c",
  • "automationName": "string"
}

Delete a customer from an automation

Deletes the customer with the given UUID from the specified automation

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

customerUuid
required
string <uuid>

The UUID of the customer

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Add a batch of customers to an automation

Adds a batch of customers to the specified automation

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The list of customers to add to the automation

Array of objects (CustomerOfBatch)
object (BatchNotification)
packet
string
Enum: "FIRST" "MIDDLE" "LAST"
sourceLabel
string
sourceUuid
string <uuid>
status
string
Enum: "OPEN" "CLOSED" "ENABLED" "ENABLED_OK_NOTIFYING" "ENABLED_ERROR_NOTIFYING" "ENABLED_OK_NOTIFIED" "ENABLED_OK_NOT_NOTIFIED" "ENABLED_ERROR_NOTIFIED" "ENABLED_ERROR_NOT_NOTIFIED"

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ],
  • "notification": {
    },
  • "packet": "FIRST",
  • "sourceLabel": "string",
  • "sourceUuid": "33c81504-964f-4455-ac8b-47961f07cd05",
  • "status": "OPEN"
}

Response samples

Content type
application/json
{
  • "sourceLabel": "string",
  • "sourceUuid": "33c81504-964f-4455-ac8b-47961f07cd05",
  • "status": "OPEN"
}

Delete an incomplete batch of customers from an automation

Deletes all customers belonging to an open batch source (by specifying sourceUuid parameter)

Authorizations:
OAuth2
path Parameters
automationUuid
required
string <uuid>

The UUID of the automation

query Parameters
sourceUuid
string

The UUID of the source

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Customer Tokens

Get token info

Retrieves the detailed of the token by its id

Authorizations:
OAuth2
path Parameters
tokenUuid
required
string <uuid>

The UUID of the token

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "userPk": "string",
  • "clabUuid": "8cbf0f5e-0020-4bd6-8925-9d4b777708ec",
  • "attributes": {
    },
  • "automationUuid": "37d046c1-2b04-4489-aa44-3e7a9ef5bf6c",
  • "automationName": "string",
  • "stepUuid": "17fc4e5d-cafc-47f1-b56e-a388e726ab24",
  • "stepOperation": "CLAB_CAMPAIGN_SMS",
  • "stepType": "ACTION",
  • "stepDescription": "string",
  • "enterStepDate": "2019-08-24T14:15:22Z",
  • "enterAutomationDate": "2019-08-24T14:15:22Z",
  • "status": "READY",
  • "automationStatus": "COMMITTED",
  • "errorDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string"
}

Search current customers in node

Retrieves a detailed list of current customers in node filtered by automation or step

Authorizations:
OAuth2
query Parameters
automationUuid
string <uuid>

The UUID of the automation

stepUuid
string <uuid>

The UUID of the step

clabUuid
string

UUID of the customer

recipient
string

email recipient

aggregatedStatus
string
Enum: "RUNNING" "COMPLETED" "ERROR"

Aggregated token status

page
integer
Default: 0

The requested page

size
integer
Default: 20

The number of elements in the page

style
string

If equals compact, show less element in response

sort
string
Enum: "automationUuid" "clabUuid" "recipient" "stepUuid" "status"

The field to sort by

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Get reports for all Tokens (ZIP)

Returns reports for all Tokens in a ZIP file

Authorizations:
OAuth2
query Parameters
automationUuid
string <uuid>

The UUID of the automation

stepUuid
string <uuid>

The UUID of the step

clabUuid
string

UUID of the customer

recipient
string

email recipient

aggregatedStatus
string
Enum: "RUNNING" "COMPLETED" "ERROR"

Aggregated token status

filename
string
Default: "automations-monitor"

filename

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

External Contents

Get Email Designer configurations

Returns Email Designer configurations of logged User (i.e. enabled)

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Get all message mail models

Returns all available mail message models (i.e. SEND Mail Groups) for the specified node

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all sms mail models

Returns all available sms message models (i.e. SMS Mail Groups) for the specified node

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get PageBuilder templates

Returns all available PageBuilder templates for the specified node

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Get all PageBuilder template's pages

Returns all pages of a PageBuilder template

Authorizations:
OAuth2
path Parameters
templateId
required
integer

Template ID

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Get a PageBuilder template's page

Returns a specific page of a given PageBuilder template

Authorizations:
OAuth2
path Parameters
templateId
required
integer

Template ID

pageId
required
integer

Page ID

header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

Send email test for step mail

Send email test for step mail

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Request Body schema: application/json
required

The test campaign resource

modelIdentifier
integer
senderName
string
senderEmail
string
senderReplyTo
string
subject
string
htmlContent
string
textContent
string
customRef
string
email
string
Array of objects (Attributes)

Responses

Request samples

Content type
application/json
{
  • "modelIdentifier": 0,
  • "senderName": "string",
  • "senderEmail": "string",
  • "senderReplyTo": "string",
  • "subject": "string",
  • "htmlContent": "string",
  • "textContent": "string",
  • "customRef": "string",
  • "email": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "errors": [
    ]
}

Send Subscriptions

Get Send subscriptions

Returns a list of Send subscriptions mapped in the source Send

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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

KPIs

Get nodes basic infos and automations status aggregate

Returns all nodes basic infos and the related automations status aggregate

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Responses

Response samples

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

Definitions

Get trigger events definitions

Return trigger events type with the related attributes

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{ }

Get events context definitions

Return context definitions with the related attributes and types

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{ }

Get customers definitions

Return customers definitions with the related attributes and types

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

Content type
application/json
{ }

Get automation categories

Returns all available automation categories

Authorizations:
OAuth2
header Parameters
Authorization
required
string

A valid OAuth2 token

Node
required
string <uuid>

The UUID of the node to operate on

Responses

Response samples

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