logo
API docs by Redocly

Marigold Engage API (1.0.0)

Team Marigold Engage: info@meetmarigold.com URL: https://developers.meetmarigold.com/engage/

Marigold Engage API Reference

By providing a fully documented API reference, we want to enable everyone to maximize the usage of the Marigold Engage Marketing Platform for automating & exchange data.

REST API

Authentication

The Marigold Engage V1 API's use the basic authentication protocol, through key/secter key authentication with the X-ApiKey Header, and value {key}:{secret}. If you have a Marigold Engage account with admin configuration rights, then you can create a Service Account under Admin Configuration --> Access Management --> Service Accounts. Make sure to select type custom for credentials for this api. that will generate these credentials.

Once this service account is generated, your Key and Secret will be made available. You can rotate this pair at any time. You can further specify an expiry date for your keys. under "endpoints" you can specify which actions on the API can be performed by this service account. If the service account does an action it is not configured for, a 401 unauthorized will be returned by the API.

Errors

Engage uses the conventional HTTP response codes to indicate successful or failed API requests.

Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an input related error or validation restrictions.

Codes in the 5xx range indicate an error with Marigold Engage servers.

HTTP Status Codes Description
200 - OK We found the request resource
201 - Created The resource is successfully created
204 - No Content The requested resources is empty
400 - Bad Request There was an error with the request. The body of the response will have more info.
401 - Unauthorized The access key was incorrect
404 - Not found The resources cannot be found
405 - Method Not Allowed The method is not allowed
408 - Request Timeout The request is taking too long to respond
422 - Unprocessable Entity The resource couldn't be created
429 - Too Many Requests Too many requests hit the API too quickly
5xx - Server errors Something went wrong on our end. Please try again

OpenAPI specification

We provide the API specification in the format of OpenApi files which can be found in the openapi/ directory:

The older Swagger/OpenAPI 2.0 can currently still be accessed from the Api explorer in engage. We will not support it explicitly here.

Postman collection

To get you up and running and provide a hands on experience, we provide an up-to-date Postman collection of the SMC API V2.

Open in Postman

Import the Postman collection through any of the methods specified below.

This collection takes advantage of Postman variables and environments to store/access your Marigold Engage API key and base URL.

  • baseUrl - Your personalised Marigold Engage base URL
  • X-ApiKey - Your Marigold Engage secret API key.

These variables can be found by navigating to "Admin Config" > "Access Management" > "Service Accounts" on the left-hand side of the administration section. Make sure your Marigold Engage Environment is active, and your variable definitions match those listed above.

Content

All content endpoints

Get content

Returns information on the requested Content.

path Parameters
api_name
required
string
Example: email_1

API name of the content.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
name
string

Name of the message.

description
string

Description of the message.

api_name
string

API name of the message.

tags
Array of strings (tags)
Default: []

Labels of the object.

type
string
Enum: "Unknown" "Email" "Page" "MobilePush" "Sms"

Channel type of the Content.

Response samples

Content type
application/json
{
  • "name": "Email Message",
  • "description": "Description for the message.",
  • "api_name": "message_1",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "type": "Email"
}

Remove content

path Parameters
api_name
required
string
Example: email_1

API name of the content.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The content has been deleted successfully"
}

Get content lock state

returns the lock state (being edited by someone) of the requested Content.

path Parameters
api_name
required
string
Example: email_1

API name of the content.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
lockstate
string
Enum: "locked" "unlocked"

State of the lock.

Response samples

Content type
application/json
{
  • "lockstate": "locked"
}

Unlock content

Forces an unlock for the requested Content.

path Parameters
api_name
required
string
Example: email_1

API name of the content.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The content has been unlocked successfully",
  • "errors": [ ]
}

Create email

API to create simple (only html) single language message of email.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
publish
boolean
Default: false

Indicate if the content should be published.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Content_Property)
name
required
string

Name of the message.

description
string

Description of the message.

api_name
required
string

API name of the message.

tags
Array of strings
Default: []

Labels of the object.

languages
required
Array of strings
default_language
string

Default language to send this message in if a recipient's language does not match any of this message's languages. If left empty, no message will be scheduled to recipients that do not match this message's languages.

empty_language
string

Fallback language to send this message in if a recipient has no language defined. If left empty, no message will be scheduled to recipients with no set language.

audience_api_name
required
string

API name of the Audience list.

folder
string <int64>

Folder ID. The root folder has ID 0.

required
object
additional property
Array of objects (Email_Header-2)
Array
from_domain
required
string

Sending domain for this email.

from_alias
required
string

Friendly name for the sender.

reply_email
string

Reply-to email address.

reply_alias
string

Reply-to Friendly name.

to_alias
required
string

Friendly name of receiver.

preheader
required
string

Preheader of the email.

subject
required
string

Subject of the email.

from_address
string

Email address of the sender.

deliverygroup_api_name
string

Delivery group to use for this email.

required
object (Email_Content-2)
text
required
string

Text version of the mail.

html
required
string

HTML content of the mail.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "properties": {
    • "name": "Email Message",
    • "description": "Description for the message.",
    • "api_name": "message_1",
    • "tags": [
      • "addresses",
      • "footer",
      • "email",
      • "holiday"
      ],
    • "languages": [
      • "EN_US",
      • "FR"
      ],
    • "default_language": "EN",
    • "empty_language": "FR",
    • "audience_api_name": "audience_1",
    • "folder": "106"
    },
  • "headers": {
    • "language1": [
      • {
        }
      ],
    • "language2": [
      • {
        }
      ]
    },
  • "content": {
    • "text": "Hello World!",
    • "html": "<html> <head> <style> h1 color: red; p color: blue; </style> </head> <body> <h1>Hello World!</h1> <p>This is Rahul</p> </body> </html>"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The Email message has been created successfully.",
  • "errors": [ ]
}

Create MMS

Create an MMS template.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
publish
boolean
Default: false

Indicate if the content should be published.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Content_Property)
name
required
string

Name of the message.

description
string

Description of the message.

api_name
required
string

API name of the message.

tags
Array of strings
Default: []

Labels of the object.

languages
required
Array of strings
default_language
string

Default language to send this message in if a recipient's language does not match any of this message's languages. If left empty, no message will be scheduled to recipients that do not match this message's languages.

empty_language
string

Fallback language to send this message in if a recipient has no language defined. If left empty, no message will be scheduled to recipients with no set language.

audience_api_name
required
string

API name of the Audience list.

folder
string <int64>

Folder ID. The root folder has ID 0.

required
object (Mms_Content-2)
object (Mms_My_Language_Code_Content-2)
text
required
string

Text content of MMS.

media_type
required
string
Enum: "IMAGE" "VIDEO" "AUDIO" "VCARD" "NONE"

The media type of the MMS.

media_url
string

The URL linking to the media you want to send in the MMS message. (Required when media_type not is 'NONE')

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "properties": {
    • "name": "Email Message",
    • "description": "Description for the message.",
    • "api_name": "message_1",
    • "tags": [
      • "addresses",
      • "footer",
      • "email",
      • "holiday"
      ],
    • "languages": [
      • "EN_US",
      • "FR"
      ],
    • "default_language": "EN",
    • "empty_language": "FR",
    • "audience_api_name": "audience_1",
    • "folder": "106"
    },
  • "content": {
    • "my_language_code": {
      • "text": "Hello world!",
      • "media_type": "IMAGE",
      • "media_url": "URL to the media"
      }
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The MMS message has been created successfully.",
  • "errors": [ ]
}

Create mobile push

API to create a Mobile push message.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
publish
boolean
Default: false

Indicate if the content should be published.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Content_Mobile_Property)
name
required
string

Name of the message.

description
string

Description of the message.

api_name
required
string

API name of the message.

tags
Array of strings
Default: []

Labels of the object.

languages
required
Array of strings
default_language
string

Default language to send this message in if a recipient's language does not match any of this message's languages. If left empty, no message will be scheduled to recipients that do not match this message's languages.

empty_language
string

Fallback language to send this message in if a recipient has no language defined. If left empty, no message will be scheduled to recipients with no set language.

audience_api_name
required
string

API name of the Audience list.

folder
string <int64>

Folder ID. The root folder has ID 0.

mobile_app_api_name
string

API name of the mobile device list. If left empty, the default mobile device list for the organization will be used.

required
object (Mobile_Property-2)
distribution_type
required
string
Enum: "Unknown" "MobilePushAndInApp" "InApp" "InAppIfPushUnavailable" "MobilePush"

Type of mobile message.

custom_in_app_content
required
boolean

Enable Custom in app content for this message.

in_app_content_type
string
Enum: "Unknown" "Text" "Url" "Image" "Page" "SmartBlock"

Type of in app content.

rich_push_content_enabled
boolean

Enable rich push for this message.

rich_push_content_type
string
Enum: "Unknown" "Image" "SmartBlock"

Type of rich push content.

expiration_date
string

Date when message should no longer be shown

required
object
additional property
Array of objects (Mobile_Content-2)
Array
object (Mobile_Push)
object (Mobile_In_App)
object (Mobile_Rich_Push)
Array of objects (Mobile_Action_Button)
object (Mobile_Link)

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "properties": {
    • "name": "Email Message",
    • "description": "Description for the message.",
    • "api_name": "message_1",
    • "tags": [
      • "addresses",
      • "footer",
      • "email",
      • "holiday"
      ],
    • "languages": [
      • "EN_US",
      • "FR"
      ],
    • "default_language": "EN",
    • "empty_language": "FR",
    • "audience_api_name": "audience_1",
    • "folder": "106",
    • "mobile_app_api_name": "mobile_device_list_1"
    },
  • "mobile_properties": {
    • "distribution_type": "MobilePush",
    • "custom_in_app_content": true,
    • "in_app_content_type": "Image",
    • "rich_push_content_enabled": true,
    • "rich_push_content_type": "Image",
    • "expiration_date": "2025-01-01"
    },
  • "content": {}
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The Mobile message has been created successfully.",
  • "errors": [ ]
}

Create page

API to create single language page content.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
publish
boolean
Default: false

Indicate if the content should be published.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Content_Property)
name
required
string

Name of the message.

description
string

Description of the message.

api_name
required
string

API name of the message.

tags
Array of strings
Default: []

Labels of the object.

languages
required
Array of strings
default_language
string

Default language to send this message in if a recipient's language does not match any of this message's languages. If left empty, no message will be scheduled to recipients that do not match this message's languages.

empty_language
string

Fallback language to send this message in if a recipient has no language defined. If left empty, no message will be scheduled to recipients with no set language.

audience_api_name
required
string

API name of the Audience list.

folder
string <int64>

Folder ID. The root folder has ID 0.

required
object (Page_Content-2)
html
required
string

HTML content of the page.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "properties": {
    • "name": "Email Message",
    • "description": "Description for the message.",
    • "api_name": "message_1",
    • "tags": [
      • "addresses",
      • "footer",
      • "email",
      • "holiday"
      ],
    • "languages": [
      • "EN_US",
      • "FR"
      ],
    • "default_language": "EN",
    • "empty_language": "FR",
    • "audience_api_name": "audience_1",
    • "folder": "106"
    },
  • "content": {
    • "html": "<html> <head> <style> h1 color: red; p color: blue; </style> </head> <body> <h1>Hello World!</h1> <p>This is Rahul</p> </body> </html>"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The Page content has been created successfully.",
  • "errors": [ ]
}

Create SMS

Create a single language SMS.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
publish
boolean
Default: false

Indicate if the content should be published.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Content_Property)
name
required
string

Name of the message.

description
string

Description of the message.

api_name
required
string

API name of the message.

tags
Array of strings
Default: []

Labels of the object.

languages
required
Array of strings
default_language
string

Default language to send this message in if a recipient's language does not match any of this message's languages. If left empty, no message will be scheduled to recipients that do not match this message's languages.

empty_language
string

Fallback language to send this message in if a recipient has no language defined. If left empty, no message will be scheduled to recipients with no set language.

audience_api_name
required
string

API name of the Audience list.

folder
string <int64>

Folder ID. The root folder has ID 0.

required
object (Sms_Content-2)
text
required
string

text content of SMS.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "properties": {
    • "name": "Email Message",
    • "description": "Description for the message.",
    • "api_name": "message_1",
    • "tags": [
      • "addresses",
      • "footer",
      • "email",
      • "holiday"
      ],
    • "languages": [
      • "EN_US",
      • "FR"
      ],
    • "default_language": "EN",
    • "empty_language": "FR",
    • "audience_api_name": "audience_1",
    • "folder": "106"
    },
  • "content": {
    • "text": "Hello world!"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The SMS message has been created successfully.",
  • "errors": [ ]
}

Dictionary

All dictionary endpoints

List dictionaries

List dictionaries matching the given criteria.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Dictionary_Base)

Collection of dictionaries.

Array
api_name
string

API name of the dictionary.

Response samples

Content type
application/json
{
  • "dictionaries": [
    • {
      • "api_name": "dictionary_1"
      }
    ]
}

Create dictionary

Create a dictionary.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

API name of the dictionary.

name
required
string

Name of the dictionary.

description
string
Default: null

Description of the dictionary.

tags
Array of strings
Default: null

Labels of the object.

organizations
Array of strings
Default: null

List of organizations linked to the object.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "dictionary_1",
  • "name": "Email Message",
  • "description": null,
  • "tags": null,
  • "organizations": null
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Dictionary created successfully.",
  • "errors": [ ]
}

Get dictionary

Use this endpoint to get details of the dictionary with the given API name.

path Parameters
api_name
required
string
Example: dictionary_1

API name of the dictionary.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

API name of the dictionary.

name
string

Name of the dictionary.

description
string

Description of the dictionary.

tags
Array of strings (tags)
Default: []

Labels of the object.

organizations
Array of strings (organizations)

List of organizations linked to the object.

not_accessible_organizations_count
integer <int32> (not_accessible_organizations_count)

Number of organizations associated with the object, That cannot be access via the API.

Response samples

Content type
application/json
{
  • "api_name": "dictionary_1",
  • "name": "Email Message",
  • "description": "Description for the dictionary.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "not_accessible_organizations_count": 1
}

Update dictionary

Use this endpoint to update an existing dictionary.

path Parameters
api_name
required
string
Example: dictionary_1

API name of the dictionary.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

API name of the dictionary.

description
string

Description of the dictionary.

tags
Array of strings (tags)
Default: []

Labels of the object.

organizations
Array of strings (organizations)

List of organizations linked to the object.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "dictionary_1",
  • "description": "Description for the dictionary.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Dictionary updated successfully.",
  • "errors": [ ]
}

Delete dictionary

Use this endpoint to delete an existing dictionary.

path Parameters
api_name
required
string
Example: dictionary_1

API name of the dictionary.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Dictionary deleted successfully.",
  • "errors": [ ]
}

Dictionary Labels

All endpoints to change labels inside a dictionary

List dictionary labels

List labels for a particular dictionary.

path Parameters
api_name
required
string
Example: data_export_1

API name of the data import.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Label)

Collection of labels.

Array
label
string

Name of the label.

object

A set of translations consisting of key value pairs where key is a language code and value is translation for that language code.

Response samples

Content type
application/json
{
  • "labels": [
    • {
      • "label": "label_1",
      • "translations": {
        }
      }
    ]
}

Create dictionary label

Use this endpoint to create a label in a dictionary.

path Parameters
api_name
required
string
Example: dictionary_1

API name of the dictionary.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
sync
boolean
Default: false
Example: sync=false

Weither or now we should sync the labels with their translations.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
label
required
string

Name of the label.

required
object

A set of translations consisting of key value pairs where key is a language code and value is translation for that language code.

language*
additional property
string

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "label": "label_1",
  • "translations": {
    • "EN": "Label1_English",
    • "DE": "Label1_Dutch"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Label created successfully.",
  • "errors": [ ]
}

Update dictionary label

Use this endpoint to update an existing label in a dictionary.

path Parameters
api_name
required
string
Example: data_export_1

API name of the data import.

label
required
string

Identifier of the label.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
sync
boolean
Default: false
Example: sync=false

Weither or now we should sync the labels with their translations.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json

The model object consists of label details that is used to update an existing label in a dictionary.

required
object

A set of translations consisting of key value pairs where key is a language code and value is translation for that language code.

language*
additional property
string

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "label": "label_1",
  • "translations": {
    • "EN": "Label1_English",
    • "DE": "Label1_Dutch"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Label updated successfully.",
  • "errors": [ ]
}

Delete dictionary label

Use this endpoint to delete a label in a dictionary.

path Parameters
api_name
required
string
Example: dictionary_1

API name of the dictionary.

label
required
string

Identifier of the label.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Label deleted successfully.",
  • "errors": [ ]
}

Journey

All journey endpoints

list journeys

Retrieve the last 1000 created journeys.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Journey_Base)

A collection of journeys.

Array
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

Response samples

Content type
application/json
{
  • "journeys": [
    • {
      • "api_name": "journey_1",
      • "type": "singlebatch"
      }
    ]
}

Single Batch journey

All single batch journey endpoints

List Single Batch journeys

Use this endpoint to retrieve all journeys on the given organization of type Single Batch.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Journey_Base)
Array
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

Response samples

Content type
application/json
{
  • "journeys": [
    • {
      • "api_name": "api_name_1",
      • "type": "singlebatch"
      },
    • {
      • "api_name": "api_name_2",
      • "type": "singlebatch"
      }
    ]
}

Create Single Batch journey

Use this endpoint to create a new Single-Batch journey.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
object (Single_Batch)
api_name
required
string

the api name for the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

object (send_in_waves)
any
disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
segment_api_name
string

Limit audience to the segment with this API name. If left empty, no such filtering is applied.

audience_filter
string

Filter audience with this condition. For example: endswith([MASTER.MAIL], '@my_company.com') to only schedule to users with an email address on the my_company.com domain.

required
object (Message)
api_name
required
string

API name of the message.

folder
required
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      },
    • "segment_api_name": "segment_1",
    • "audience_filter": "endswith([MASTER.MAIL], '@my_company.com')"
    },
  • "message": {
    • "api_name": "message_1"
    },
  • "folder": "106"
}

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    },
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ]
}

Get Single Batch journey

Use this endpoint to retrieve information on the Single Batch journey with the given api name.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    }
}

Delete Single Batch journey

Use this endpoint to delete existing single batch journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been deleted successfully"
}

Cancel a journey

Cancel the execution or scheduled execution of a Single Batch journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been cancelled successfully."
}

Launch a single batch journey

Launch a specific Single Batch journey given the schedule.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
launch_state
string (launch_state)

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
required
object (Scheduling_Required)
launch_date
required
string <date-time>

Launch date and time of the journey.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
Example
{
  • "launch_state": "scheduled",
  • "scheduling": {
    • "launch_date": "2023-12-15T10:11:17.9968156Z"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been launched successfully."
}

Trigger single batch journey

Use this endpoint to trigger a Single-Batch journey execution.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
any
api_name
required
string

the api name for the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

object (send_in_waves)
any
disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
required
object (Scheduling_Required)

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    }
}

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    },
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ]
}

Send Single Batch email journey

Use this end point to send single batch with an email message.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

object (send_in_waves)
any
disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
segment_api_name
string

Limit audience to the segment with this API name. If left empty, no such filtering is applied.

audience_filter
string

Filter audience with this condition. For example: endswith([MASTER.MAIL], '@my_company.com') to only schedule to users with an email address on the my_company.com domain.

object (Email-2)
required
object (Content_Property)
required
object
required
object (Email_Content-2)
folder
required
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "journey_model": {
    • "api_name": "journey_1",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      },
    • "segment_api_name": "segment_1",
    • "audience_filter": "endswith([MASTER.MAIL], '@my_company.com')"
    },
  • "message_model": {
    • "properties": {
      • "name": "Email Message",
      • "description": "Description for the message.",
      • "api_name": "message_1",
      • "tags": [
        ],
      • "languages": [
        ],
      • "default_language": "EN",
      • "empty_language": "FR",
      • "audience_api_name": "audience_1",
      • "folder": "106"
      },
    • "headers": {
      • "language1": [
        ],
      • "language2": [
        ]
      },
    • "content": {
      • "text": "Hello World!",
      • "html": "<html> <head> <style> h1 color: red; p color: blue; </style> </head> <body> <h1>Hello World!</h1> <p>This is Rahul</p> </body> </html>"
      }
    },
  • "folder": "106"
}

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    },
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ]
}

Send Single Batch mobile push journey

Use this end point to send single batch with a mobile push message.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

object (send_in_waves)
any
disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
segment_api_name
string

Limit audience to the segment with this API name. If left empty, no such filtering is applied.

audience_filter
string

Filter audience with this condition. For example: endswith([MASTER.MAIL], '@my_company.com') to only schedule to users with an email address on the my_company.com domain.

object (Mobile-2)
required
object (Content_Mobile_Property)
required
object (Mobile_Property-2)
required
object
folder
required
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "journey_model": {
    • "api_name": "journey_1",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      },
    • "segment_api_name": "segment_1",
    • "audience_filter": "endswith([MASTER.MAIL], '@my_company.com')"
    },
  • "mobile_message_model": {
    • "properties": {
      • "name": "Email Message",
      • "description": "Description for the message.",
      • "api_name": "message_1",
      • "tags": [
        ],
      • "languages": [
        ],
      • "default_language": "EN",
      • "empty_language": "FR",
      • "audience_api_name": "audience_1",
      • "folder": "106",
      • "mobile_app_api_name": "mobile_device_list_1"
      },
    • "mobile_properties": {
      • "distribution_type": "MobilePush",
      • "custom_in_app_content": true,
      • "in_app_content_type": "Image",
      • "rich_push_content_enabled": true,
      • "rich_push_content_type": "Image",
      • "expiration_date": "2025-01-01"
      },
    • "content": {}
    },
  • "folder": "106"
}

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    },
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ]
}

Send Single Batch SMS journey

Use this end point to send single batch with an SMS.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

object (send_in_waves)
any
disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
segment_api_name
string

Limit audience to the segment with this API name. If left empty, no such filtering is applied.

audience_filter
string

Filter audience with this condition. For example: endswith([MASTER.MAIL], '@my_company.com') to only schedule to users with an email address on the my_company.com domain.

object (Sms-2)
required
object (Content_Property)
required
object (Sms_Content-2)
folder
required
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

Responses

Response Schema: application/json
object (Single_Batch)
api_name
required
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
required
string

Name of the journey.

campaign_analytics_tag
string

The campaign_analytics_tag of the journey.

message_analytics_tag
string

The message_analytics_tag of the journey.

object (Deduplication)

This can be used to check your audience for duplicate contacts before targeting them. By default, this check is not performed.

disable_flags
boolean
Default: false

Do not store interaction data for user interactions from this journey.

disable_tracking
boolean
Default: false

Do not add tracking parameters to external URLs generated for clicks in this journey. Trackers are defined in the Data Integration section of the Admin Configuration.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
object (Scheduling)
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "journey_model": {
    • "api_name": "journey_1",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      },
    • "segment_api_name": "segment_1",
    • "audience_filter": "endswith([MASTER.MAIL], '@my_company.com')"
    },
  • "sms_model": {
    • "properties": {
      • "name": "Email Message",
      • "description": "Description for the message.",
      • "api_name": "message_1",
      • "tags": [
        ],
      • "languages": [
        ],
      • "default_language": "EN",
      • "empty_language": "FR",
      • "audience_api_name": "audience_1",
      • "folder": "106"
      },
    • "content": {
      • "text": "Hello world!"
      }
    },
  • "folder": "106"
}

Response samples

Content type
application/json
{
  • "journey": {
    • "api_name": "journey_1",
    • "type": "singlebatch",
    • "name": "Christmas Campaign 1",
    • "campaign_analytics_tag": "christmas_2424",
    • "message_analytics_tag": "batch_2",
    • "deduplication": {
      • "fields": [
        ],
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "send_in_waves": {
      • "type": "Waves",
      • "interval_in_minutes": 60,
      • "number_of_waves": 5,
      • "items_per_wave": 50000
      },
    • "sending_limit": {
      • "percentage": 15,
      • "type": "Absolute",
      • "sort_selection": "Sorted",
      • "sort_field": "MASTER.ID",
      • "sort_descending": true
      },
    • "disable_flags": true,
    • "disable_tracking": true,
    • "launch_state": "launch",
    • "scheduling": {
      • "launch_date": "2023-12-15T10:11:17.9968156Z"
      }
    },
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ]
}

AB journey

All ab journey endpoints

Get AB journey

Use this endpoint to check whether AB journey already exists.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
string

Name of the journey.

description
string

Description of the journey.

Response samples

Content type
application/json
{
  • "api_name": "journey_1",
  • "type": "ab",
  • "name": "journey_1",
  • "description": "this is the description."
}

Delete AB journey

Use this endpoint to delete existing AB journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been deleted successfully",
  • "errors": [ ]
}

Recurring journey

All recurring journey endpoints

Get recurring journey

retrieve information about the specified recurring journey, if it exists.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
string

Name of the journey.

description
string

Description of the journey.

Response samples

Content type
application/json
{
  • "api_name": "journey_1",
  • "type": "recurring",
  • "name": "journey_1",
  • "description": "this is the description."
}

Delete recurring journey

Delete an existing recurring journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been deleted successfully",
  • "errors": [ ]
}

Transactional journey

All transactional journey endpoints

List Transactional journeys

Use this endpoint to retrieve all journeys on the given organization of type Transactional.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Journey_Base)
Array
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

Response samples

Content type
application/json
{
  • "journeys": [
    • {
      • "api_name": "api_name_1",
      • "type": "transactional"
      },
    • {
      • "api_name": "api_name_2",
      • "type": "transactional"
      }
    ]
}

Get Transactional journey

Use this endpoint to retrieve information on the transactional journey with the given api name.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

launch_state
string (launch_state)
Enum: "none" "launch" "schedule"

The state of the journey.

  • none - Journey is not launched.
  • launch - Journey is launched immediately.
  • schedule - Journey is scheduled at a specified time.
name
string

Name of the journey.

campaign_analytics_tag
string

Analytics tag for this journey.

message_analytics_tag
string

Analytics tag for this message. Omitted if empty.

Response samples

Content type
application/json
{
  • "api_name": "journey_1",
  • "type": "transactional",
  • "launch_state": "none",
  • "name": "Christmas Campaign 1",
  • "campaign_analytics_tag": "christmas_campaign",
  • "message_analytics_tag": "christmas_campaign_message"
}

Delete Transactional journey

Use this endpoint to delete existing transactional journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The journey has been deleted successfully.",
  • "errors": [ ]
}

Trigger Transactional journey(s)

Use this endpoint to send (multiple) transactional messages (email mobile push sms).

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
object
email
string
Deprecated

Deprecated Use recipient instead.

recipient
required
string

Recipient to which the message should be sent. Depending on lookup, this can either be a user id or an email address.

language
required
string

Language in which the message should be sent. This is only applied when targeting users that do not yet exist in your audience.

data
object

Data that is configured on the Transactional data and that should be passed or is optional. Check the definition of your transactional journey for this schema.

Array of objects (Transactional_Data_Selection)

Data on the defined Data selections for this journey. Selection of key ID fields with the corresponding values to select.

object (Transactional_Lookup)

Determines how the recipient field should be interpreted. By default, it will match on MASTER.MAIL.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Array of objects

List of provided initial data.

Array
email
string
Deprecated

Deprecated Use recipient instead.

recipient
string

Recipient to which the message should be sent. Depending on lookup, this can either be a user id or an email address.

language
string

Language in which the message should be sent. This is only applied when targeting users that do not yet exist in your audience.

data
object

Data that is configured on the Transactional data and that should be passed or is optional. Check the definition of your transactional journey for this schema.

Array of objects (Transactional_Data_Selection)

Data on the defined Data selections for this journey. Selection of key ID fields with the corresponding values to select.

object (Transactional_Lookup)

Determines how the recipient field should be interpreted. By default, it will match on MASTER.MAIL.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

Array of objects (Errors)

List of errors.

Array of objects
Array
id
string <uuid>

Message ID of the newly sent messages. Either these ids or the user-supplied sg_external_ids can be used as input for the Transactional_GetStatusById and Transactional_GetStatus calls.

Request samples

Content type
application/json
{
  • "items": {
    • "email": "john.doe@doe.com",
    • "recipient": "john.doe@doe.com",
    • "language": "en-US",
    • "data": {
      • "required_string_1": "John",
      • "optional_integer_1": 1,
      • "required_integer_1": 5
      },
    • "dtsdata": [
      • {
        }
      ],
    • "lookup": {
      • "scope": "MASTER",
      • "field": "MAIL"
      },
    • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ],
  • "response_data": [
    • {
      • "email": "john.doe@doe.com",
      • "recipient": "john.doe@doe.com",
      • "language": "en-US",
      • "data": {
        },
      • "dtsdata": [
        ],
      • "lookup": {
        },
      • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94",
      • "errors": [
        ]
      }
    ],
  • "messages": [
    • {
      • "id": "e82d48e6-f083-4a88-a842-524b3d8992de"
      }
    ]
}

Update User and trigger Transactional journey

Use this endpoint to update the user profile with given data and then send (multiple) transactional messages (email mobile push sms).

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
object (Transactional_Update_Send)
email
string
Deprecated

Deprecated Use recipient instead.

recipient
required
string

Recipient to which the message should be sent. Depending on lookup, this can either be a user id or an email address.

language
required
string

Language in which the message should be sent. This is only applied when targeting users that do not yet exist in your audience.

data
object

Data that is configured on the Transactional data and that should be passed or is optional. Check the definition of your transactional journey for this schema.

Array of objects (Transactional_Data_Selection)

Data on the defined Data selections for this journey. Selection of key ID fields with the corresponding values to select.

object (Transactional_Lookup)

Determines how the recipient field should be interpreted. By default, it will match on MASTER.MAIL.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

Array of objects (Transactional_Profile)

Profile of the user. You can update items on the main list or related lists.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Array of objects

List of provided initial data.

Array
email
string
Deprecated

Deprecated Use recipient instead.

recipient
string

Recipient to which the message should be sent. Depending on lookup, this can either be a user id or an email address.

language
string

Language in which the message should be sent. This is only applied when targeting users that do not yet exist in your audience.

data
object

Data that is configured on the Transactional data and that should be passed or is optional. Check the definition of your transactional journey for this schema.

Array of objects (Transactional_Data_Selection)

Data on the defined Data selections for this journey. Selection of key ID fields with the corresponding values to select.

object (Transactional_Lookup)

Determines how the recipient field should be interpreted. By default, it will match on MASTER.MAIL.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

Array of objects (Errors)

List of errors.

Array of objects
Array
id
string <uuid>

Message ID of the newly sent messages. Either these ids or the user-supplied sg_external_ids can be used as input for the Transactional_GetStatusById and Transactional_GetStatus calls.

Request samples

Content type
application/json
{
  • "items": {
    • "email": "john.doe@doe.com",
    • "recipient": "john.doe@doe.com",
    • "language": "en-US",
    • "data": {
      • "required_string_1": "John",
      • "optional_integer_1": 1,
      • "required_integer_1": 5
      },
    • "dtsdata": [
      • {
        }
      ],
    • "lookup": {
      • "scope": "MASTER",
      • "field": "MAIL"
      },
    • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94",
    • "profile": [
      • {
        }
      ]
    }
}

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ],
  • "response_data": [
    • {
      • "email": "john.doe@doe.com",
      • "recipient": "john.doe@doe.com",
      • "language": "en-US",
      • "data": {
        },
      • "dtsdata": [
        ],
      • "lookup": {
        },
      • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94",
      • "errors": [
        ]
      }
    ],
  • "messages": [
    • {
      • "id": "e82d48e6-f083-4a88-a842-524b3d8992de"
      }
    ]
}

List status Transactional journeys

Use this endpoint to get the status of multiple transactional messages.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
ids
Array of strings <uuid>

List of message IDs to look for. These are system-generated and returned by the Send and UpdateProfileAndSend calls.

sg_external_ids
Array of strings <uuid>

List of External IDs to look for. This is useful if you supplied those in the Send or UpdateProfileAndSend call.

Responses

Response Schema: application/json
Array
id
string <uuid>

ID of the message.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

status
integer <int32>

status code of the message.

status_message
string

Readable version of the message status.

Request samples

Content type
application/json
{
  • "ids": [
    • "055979c7-d2ec-4d83-abb4-fde70cc1aac5",
    • "754c4ea5-621c-4a9d-9932-53ef68542945"
    ],
  • "sg_external_ids": [
    • "c1379533-b642-48ee-968a-b952c042ed94",
    • "7efd3f07-3eb4-4bce-b26c-672603ea7f20"
    ]
}

Response samples

Content type
application/json
[
  • {
    • "id": "7aba31fe-490c-46f0-bd5e-82a0bc5648fc",
    • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94",
    • "status": 30,
    • "status_message": "Mail was sent"
    }
]

Get status transactional journey

Use this endpoint to get the status of a transactional message with a given id.

path Parameters
id
required
string <uuid>
Example: 973592c1-7198-4b10-aab1-db0da381cd13

ID of the message. This is found in the return model of the Send or UpdateProfileAndSend call.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
id
string <uuid>

ID of the message.

sg_external_id
string <uuid> (sg_external_id)

A uuid you can use to trace this message. This is an accepted input for the Transactional_GetStatus call.

status
integer <int32>

status code of the message.

status_message
string

Readable version of the message status.

Response samples

Content type
application/json
{
  • "id": "7aba31fe-490c-46f0-bd5e-82a0bc5648fc",
  • "sg_external_id": "c1379533-b642-48ee-968a-b952c042ed94",
  • "status": 30,
  • "status_message": "Mail was sent"
}

Transactional Bulk journey

All transactional bulk journey endpoints

Trigger Transactional Bulk journey

Use this method to trigger a bulk journey in a transactional way

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "an error has occurred"
      }
    ]
}

Custom journey

All custom journey endpoints

Get custom journey

Use this endpoint to check whether custom journey already exists.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

the api name for the journey.

type
string (JourneyType)
Enum: "unknown" "singlebatch" "transactional" "ab" "recurring" "custom"

the type of the journey.

name
string

Name of the journey.

description
string

Description of the journey.

Response samples

Content type
application/json
{
  • "api_name": "journey_1",
  • "type": "custom",
  • "name": "journey_1",
  • "description": "this is the description."
}

Delete custom journey

Use this endpoint to delete existing custom journey.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema:
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
{
  • "result_code": "Succeeded",
  • "message": "The journey has been deleted successfully"
}

Custom journey entrypoint

All custom journey endpoints

List custom journey entrypoint components

Lists all entry point components in the custom journey usable via api.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array
Array of objects (Entrypoint)

A collection of entrypoints.

Array
info
string

Can contain some important system information.

object

Response samples

Content type
application/json
[
  • {
    • "info": null,
    • "model": {
      • "entry_point_type": "Input",
      • "name": "My name of the entry point",
      • "api_name": "entrypoint_api_name"
      }
    },
  • {
    • "info": "this entry point can not be used to trigger the journey as it is not yet published",
    • "model": {
      • "entry_point_type": "Input",
      • "name": null,
      • "api_name": null
      }
    }
]

Get custom journey entrypoint

Gets detailed information about the entry point component.

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

entrypoint_api_name
required
string
Example: entrypoint_api_name_custom_journey

the api name of the entry point defined in the custom journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
info
string

Can contain some important system information.

object
entry_point_type
string
Value: "Input"

type of entrypoint.

name
string

name of entrypoint.

api_name
string

API name of the entrypoint.

Array of objects

Parameters defined for this entrypoint.

Array
name
string

Name of the parameter to be provided on this input.

required
boolean

Indicates if this parameter is required.

Response samples

Content type
application/json
{
  • "system_info": "some optional system information about the entry point.",
  • "model": {
    • "entry_point_type": "Input",
    • "name": "My name of the entry point",
    • "api_name": "entrypoint_api_name",
    • "parameters": [
      • {
        },
      • {
        }
      ]
    }
}

Trigger custom journey entrypoint

This will trigger a specific start component in the custom journey

path Parameters
api_name
required
string
Example: newsletter_1

API name of the journey.

entrypoint_api_name
required
string
Example: entrypoint_api_name_custom_journey

the api name of the entry point defined in the custom journey.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
user_id
integer <int64>

The id of the user on the current context (eg. default 0 same as Anonymous)

object

The parameter and the value of that parameter that needs to be processed.

property name*
additional property
string

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

result_type
string
Enum: "None" "Content" "Redirect" "Validation" "Error"

Resulting body type from the entry call.

body
string

The returned data from the entrypoint.

Request samples

Content type
application/json
{
  • "user_id": 1,
  • "parameter_values": {
    • "USERNAME": "Bob",
    • "OPTIN": true
    }
}

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "result_type": "Content",
  • "body": "<html></html>"
}

List

All list endpoints

Get lists

Get Lists defined for an organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "Unknown" "Userlist" "Datalist" "DataSelectionList" "Optionlist" "Devicelist"
Example: filter=UserList, Datalist

Filter by list typ(s). Multiple types can be provided comma separated.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: -1
Example: take=1

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects

Collection of lists.

Array
api_name
string

API name for a list.

name
string

Name of the list.

id
integer <int64>

ID of the list.

type
string
Enum: "Unknown" "Userlist" "Datalist" "DataSelectionList" "Optionlist" "Devicelist"

Type of the list.

Response samples

Content type
application/json
{
  • "list": [
    • {
      • "api_name": "list_1",
      • "name": "List 1",
      • "id": 1,
      • "type": "Userlist"
      }
    ]
}

Create list

Create a new list in the given organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

API name for a list.

name
required
string

Name of the list.

tags
Array of strings (tags)
Default: []

Labels of the object.

description
string
Default: ""

A description of what this list is about.

enforce_segment_selection
boolean
Default: false

Enforce segment selection for user lists (Only applicable for user lists)

folder
string
Default: "0"

Folder id to store the list in.

optionlist_codetype
string
Default: "Text"
Enum: "Unknown" "Text" "Numeric"

Option list code type for option lists (Only applicable for option lists)

type
required
string
Enum: "Unknown" "Userlist" "Datalist" "DataSelectionList" "Optionlist" "Devicelist"

Type of the list.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "list_1",
  • "name": "List 1",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "description": "This is my first userlist",
  • "enforce_segment_selection": true,
  • "folder": "folder_1",
  • "optionlist_codetype": "Text",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "List created successfully."
}

Get List

Get a list of details for the list with the given API name.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

API name for a list.

name
string

Name of the list.

tags
Array of strings (tags)
Default: []

Labels of the object.

enforce_segment_selection
boolean
Default: false

Enforce segment selection for user lists (Only applicable for user lists)

organizations
Array of strings

List of organizations linked to the object.

not_accessible_organizations_count
integer <int32>

Number of organizations associated with the object, That cannot be access via the API.

object (List_Email_Quality)
email_quality_type
string
Enum: "Defensive" "Normal" "Aggressive" "Custom"

The email quality type setting, configures options for the email quality checks.

invalid_email_syntax
integer <int32>

Amount of occurrences of invalid email syntax before email quality control is triggered.

non_existing_domain
integer <int32>

Amount of occurrences of non-existing domain before email quality control is triggered.

hard_bounce
integer <int32>

Amount of hard bounces before email quality control is triggered.

soft_bounce
integer <int32>

Amount of soft bounces before email quality control is triggered.

bounce_scope
string

Name of the relation to the list that holds the bounce counters.

Array of objects (List_Email_Quality_Action)
bounce_stored_procedures
Array of strings

List of stored procedures to be executed when email quality control is triggered.

taglist_api_name
string

API name of Tag list.

type
string (type-2)
Enum: "Unknown" "Userlist" "Datalist" "DataSelectionList" "Optionlist" "Devicelist"

Type of the list.

Response samples

Content type
application/json
{
  • "api_name": "list_1",
  • "name": "List 1",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "enforce_segment_selection": true,
  • "organizations": [ ],
  • "not_accessible_organizations_count": 1,
  • "email_quality_configuration": {
    • "email_quality_type": "Normal",
    • "invalid_email_syntax": 1,
    • "non_existing_domain": 1,
    • "hard_bounce": 1,
    • "soft_bounce": 3,
    • "bounce_scope": "MASTER",
    • "email_quality_actions": [
      • {
        }
      ],
    • "bounce_stored_procedures": [
      • "SP_HANDLE_EMAIL_QUALITY_CONTROL"
      ]
    },
  • "taglist_api_name": "tag_list_1",
  • "type": "Userlist"
}

Update list

Use this endpoint to update a list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string

API name for a list.

name
string

Name of the list.

tags
Array of strings (tags)
Default: []

Labels of the object.

description
string
Default: ""

A description of what this list is about.

enforce_segment_selection
boolean
Default: false

Enforce segment selection for user lists (Only applicable for user lists)

taglist_api_name
string

API name of Tag list.

object (List_Email_Quality)
email_quality_type
string
Enum: "Defensive" "Normal" "Aggressive" "Custom"

The email quality type setting, configures options for the email quality checks.

bounce_scope
string

Name of the relation to the list that holds the bounce counters.

Array of objects (List_Email_Quality_Action)
bounce_stored_procedures
Array of strings

List of stored procedures to be executed when email quality control is triggered.

type
string
Enum: "Unknown" "Userlist" "Datalist" "DataSelectionList" "Optionlist" "Devicelist"

Type of the list.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "list_1",
  • "name": "List 1",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "description": "This is my first userlist",
  • "enforce_segment_selection": true,
  • "taglist_api_name": "tag_list_1",
  • "email_quality_configuration": {
    • "email_quality_type": "Normal",
    • "bounce_scope": "MASTER",
    • "email_quality_actions": [
      • {
        }
      ],
    • "bounce_stored_procedures": [
      • "SP_HANDLE_EMAIL_QUALITY_CONTROL"
      ]
    },
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "List updated successfully."
}

Delete list

Delete a list by its API name in the given organization.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
dropTable
boolean
Default: false
Example: dropTable=false

Specify if the associated table is to be deleted.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The list has been deleted successfully"
}

List Custom Event

All list event endpoints

List Custom Events

Use this endpoint to get custom events

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "Streaming" "Scheduled"
Example: filter=Streaming,Scheduled

Filter by event type.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (List_Custom_Event_Base)

the custom events matching the criteria on the specified list.

Array
name
string

Name of the custom event.

Response samples

Content type
application/json
{
  • "custom_events": [
    • {
      • "name": "Custom event 1"
      },
    • {
      • "name": "Custom event 2"
      },
    • {
      • "name": "Custom event 3"
      }
    ]
}

Create List Custom Event

Use this endpoint to create a new custom event.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

Request Body schema: application/json
name
required
string

Name of the custom event.

tags
Array of strings
Default: []

Labels of the object.

description
string
Default: ""

A description of what this custom event is about.

type
required
string (type-3)
Enum: "Streaming" "Scheduled"

Type of the custom event.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "name": "Custom event 1",
  • "tags": [ ],
  • "description": "This is my first custom event",
  • "type": "Streaming"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The custom event has been saved successfully."
}

Get List Custom Event

Use this endpoint to get custom event details based on list API name and custom event name.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
object (List_Custom_Event)
name
string

Name of the custom event.

description
string
Default: ""

A description of what this custom event is about.

type
string (type-3)
Enum: "Streaming" "Scheduled"

Type of the custom event.

transaction_field
string

Represents Transaction Field of the custom event

Response samples

Content type
application/json
{
  • "custom_event": {
    • "name": "Custom event 1",
    • "description": "This is my first custom event",
    • "type": "Streaming",
    • "transaction_field": "USER_ID"
    }
}

Update List Custom Event

Use this endpoint to update a custom event.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
name
string

Name of the custom event.

tags
Array of strings
Default: []

Labels of the object.

description
string
Default: ""

A description of what this custom event is about.

transaction_field
string

field on the Linked list to connect the custom event to

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "name": "Custom event 1",
  • "tags": [ ],
  • "description": "This is my first custom event",
  • "transaction_field": "USER_ID"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The custom event has been updated successfully."
}

Delete List Custom Event by name

Use this endpoint to delete a custom event by its name in the given organization.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
dropTable
boolean
Default: false
Example: dropTable=false

Specify if the associated table is to be deleted.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The custom event has been deleted successfully"
}

Trigger custom event Data processing

Use this endpoint to trigger the system, to process all incoming data on the custom event.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "trigger custom event request accepted and waiting to be processed."
}

Get custom event fields

Use this endpoint to get custom event fields based on list API name and custom event name.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of (Simple field (object) or Computed field (object) or Lookup field (object)) or List_Custom_Event_Field_Json (object)

List of fields to create on the custom event.

Array
One of
One of
name
required
string

Name of the field.

length
integer <int32>
Default: 50

The length of the field.

data_type
required
string (data_type)
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

description
string
Default: ""

Description about the field.

allow_null
boolean
Default: true

Allow null values for this field.

content
string
Enum: "Unknown" "Free" "Single" "Multi" "ComputedNonPersisted" "ComputedPersisted" "Lookup"

The type of field stored.

Response samples

Content type
application/json
{
  • "fields": [
    • {
      • "name": "field_1",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_2",
      • "data_type": "Numeric",
      • "description": "This is a field of type numeric.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_3",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text with text optionlist association.",
      • "allow_null": true,
      • "content": "Multi",
      • "optionlist": "Optionlist_Text_ApiName"
      },
    • {
      • "name": "field_4",
      • "data_type": "Numeric",
      • "description": "This is a field of type numeric with numeric optionlist association.",
      • "allow_null": false,
      • "content": "Single",
      • "optionlist": "Optionlist_Numeric_ApiName"
      },
    • {
      • "name": "field_5",
      • "data_type": "Boolean",
      • "description": "This is a field of type boolean.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_6",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text.",
      • "allow_null": true,
      • "content": "ComputedPersisted",
      • "value_definition": "[%[MASTER.ID]%]"
      },
    • {
      • "name": "field_7",
      • "data_type": "Json",
      • "description": "This is a field of type json.",
      • "allow_null": true,
      • "content": "Free",
      • "json_schema": [
        ]
      }
    ]
}

Create custom event field

Use this endpoint to create a custom event fields.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of (Simple field (object) or Computed field (object) or Lookup field (object)) or List_Custom_Event_Field_Json (object)

List of fields to create on the custom event.

Array
One of
One of
name
required
string

Name of the field.

length
integer <int32>
Default: 50

The length of the field.

data_type
required
string (data_type)
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

description
string
Default: ""

Description about the field.

allow_null
boolean
Default: true

Allow null values for this field.

content
string
Enum: "Unknown" "Free" "Single" "Multi" "ComputedNonPersisted" "ComputedPersisted" "Lookup"

The type of field stored.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "fields": [
    • {
      • "name": "field_1",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_2",
      • "data_type": "Numeric",
      • "description": "This is a field of type numeric.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_3",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text with text optionlist association.",
      • "allow_null": true,
      • "content": "Multi",
      • "optionlist": "Optionlist_Text_ApiName"
      },
    • {
      • "name": "field_4",
      • "data_type": "Numeric",
      • "description": "This is a field of type numeric with numeric optionlist association.",
      • "allow_null": false,
      • "content": "Single",
      • "optionlist": "Optionlist_Numeric_ApiName"
      },
    • {
      • "name": "field_5",
      • "data_type": "Boolean",
      • "description": "This is a field of type boolean.",
      • "allow_null": false,
      • "content": "Free"
      },
    • {
      • "name": "field_6",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text.",
      • "allow_null": true,
      • "content": "ComputedPersisted",
      • "value_definition": "[%[MASTER.ID]%]"
      },
    • {
      • "name": "field_7",
      • "data_type": "Json",
      • "description": "This is a field of type json.",
      • "allow_null": true,
      • "content": "Free",
      • "json_schema": [
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Fields created successfully."
}

Delete Custom Event field

Use this endpoint to delete a custom event field based on list's API name, custom event name and name of the field.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

name
required
string
Example: storedprocedure_1

Name of the field.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The custom event field has been deleted successfully"
}

Update list custom event field

Use this endpoint to update a custom event field.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

custom_event_name
required
string
Example: custom_event_1

Name of the custom event.

name
required
string
Example: storedprocedure_1

Name of the field.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
One of
One of
name
string

Name of the field.

description
string

Description about the field.

content
string
Enum: "Unknown" "Free" "Single" "Multi" "ComputedNonPersisted" "ComputedPersisted" "Lookup"

The type of field stored.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "name": "FIELD",
  • "description": "This is FIELD with text optionlist association.",
  • "content": "Free",
  • "optionlist": "option_list_api_name",
  • "json_schema": [
    • {
      • "name": "TextElement",
      • "input_type": "Text",
      • "required": true
      },
    • {
      • "name": "DateElement",
      • "input_type": "Date",
      • "required": true
      },
    • {
      • "name": "ArrayElement",
      • "input_type": "Array",
      • "required": true,
      • "child_data": [
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The custom event field has been updated successfully."
}

List data

All list data endpoints

Create / Update data record

Use this endpoint to create or update a single record with data on a 1:1 relation.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
keyFields
required
string
Example: keyFields=key1,key2,key3

A comma-separated list of the key fields that need to be used.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
scope*
additional property
any

The value for the specific field.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "id": "1",
  • "mail": "john.doe@gmail.com",
  • "master.name": "Doe",
  • "scope1.field": "someValue",
  • "scope2.field": "someOtherValue"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Record ID 13 inserted on List DataApiOneToOne_A."
}

Delete list data records

Use this endpoint to delete data from a specific table.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
keyFields
required
string
Example: keyFields=key1,key2,key3

A comma-separated list of the key fields that need to be used.

fields
string
Default: null
Example: fields=field1,field2

A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.

mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

errorHandling
string
Default: "StopOnError"
Enum: "StopOnError" "ContinueOnError"
Example: errorHandling=StopOnError

Parameter indicates error handling options whether to stop on error or continue on error. (None, StopOnError or ContinueOnError)

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

result_code
string
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Indicates the resultCode for the request.

number_of_duplicate_records
integer <int64>

When the data deletion succeeded, this property contains the number of duplicate records

number_of_failed_records
integer <int64>

When the data deletion partially succeeded, this property contains the number of failed records

number_of_records_not_found
integer <int64>
Array of objects or null (Data_Load_Invalid)

When the data deletion partially succeeded, this property contains information about the invalid records

Array
record_index
integer <int32>

Index of the invalid record.

field_name
string

Name of the field that contains the invalid data, if applicable.

message
string

Message containing information about the error.

validation_code
string
Enum: "Unknown" "InvalidFieldCount" "MaxStringLengthExceeded" "InvalidType"

Validation code indicating the error.

number_of_deleted_records
integer <int64>

When the data deletion succeeded, this property contains the number of deleted records

Response samples

Content type
application/json
{
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ],
  • "result_code": "PartiallySucceeded",
  • "number_of_duplicate_records": 0,
  • "number_of_failed_records": 2,
  • "number_of_records_not_found": 0,
  • "invalid_records": [
    • {
      • "record_index": 17,
      • "field_name": "EMAIL",
      • "message": "Record contains incorrect number of fields",
      • "validation_code": "InvalidFieldCount"
      }
    ],
  • "number_of_deleted_records": 48
}

Create / update List data

Use this endpoint to load data into a specific table.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
keyFields
required
string
Example: keyFields=key1,key2,key3

A comma-separated list of the key fields that need to be used.

fields
string
Default: null
Example: fields=field1,field2

A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.

mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

deduplication
string
Default: "ImportLastMatch"
Enum: "None" "ImportLastMatch" "ImportFirstMatch"
Example: deduplication=ImportLastMatch

The de-duplication option to use.

data_import_option
string
Default: "InsertAndUpdate"
Enum: "InsertAndUpdate" "OnlyInsert" "OnlyUpdate"
Example: data_import_option=InsertAndUpdate

Indicates the data import option during an import data.

create_segment_name
string
Default: null
Example: create_segment_name=Segment name

Indicates the name of segment at the time of segment creation.

create_segment_api_name
string
Default: null
Example: create_segment_api_name=segment_api_name

Indicates the api name of segment at the time of segment creation.

errorHandling
string
Enum: "StopOnError" "ContinueOnError"
Example: errorHandling=StopOnError

Parameter indicates error handling options: whether to stop on error or continue on error.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

result_code
string
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Indicates the resultCode for the request.

number_of_duplicate_records
integer <int64>

When the data deletion succeeded, this property contains the number of duplicate records

number_of_failed_records
integer <int64>

When the data deletion partially succeeded, this property contains the number of failed records

number_of_records_not_found
integer <int64>
Array of objects or null (Data_Load_Invalid)

When the data deletion partially succeeded, this property contains information about the invalid records

Array
record_index
integer <int32>

Index of the invalid record.

field_name
string

Name of the field that contains the invalid data, if applicable.

message
string

Message containing information about the error.

validation_code
string
Enum: "Unknown" "InvalidFieldCount" "MaxStringLengthExceeded" "InvalidType"

Validation code indicating the error.

number_of_inserted_records
integer <int64>

When the data load succeeded, this property contains the number of inserted records

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "number_of_inserted_records": 50,
  • "number_of_failed_records": 2,
  • "number_of_updated_records": 48,
  • "number_of_duplicate_records": 0,
  • "number_of_records_not_found": 0,
  • "invalid_records": [
    • {
      • "record_index": 10,
      • "field_name": "SOMESTRING",
      • "message": "Length of string (53) exceeds maximum field length (50)",
      • "validation_code": "MaxStringLengthExceeded"
      },
    • {
      • "record_index": 17,
      • "message": "Record contains incorrect number of fields",
      • "validation_code": "InvalidFieldCount"
      }
    ]
}

Search List records

Use this endpoint to search for data records in a specific table. Searching data can be done synchronous or streamed. The data in the response will be in a Json format.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
fields
required
Array of strings

An array of fields to be returned for a record.

Array of objects (List_Data_Search_Filter)
Default: []

filters to apply for the search. Works as an AND.

Array
field_name
string

Name of the field to check against.

operator
string
Enum: "Unknown" "EqualTo" "NotEqualTo" "GreaterThan" "GreaterThanOrEqualTo" "LessThan" "LessThanOrEqualTo" "Like" "IsNull" "IsNotNull" "IsEmpty" "IsNotEmpty"
field_value
string

the value to compaire against.

skip
integer <int32>
Default: 0

The index to start from, skipping all the previous results.

take
integer <int32>
Default: null

The maximum amount of items to return. By Default all items are returned.

order_by
string
Default: "MASTER.ID"

Field to order the results on.

order_by_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Order direction of the results.

Responses

Response Schema: application/json
fields
Array of strings

An array of fields to be returned for a record.

Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

data
Array of arrays

List of records

result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Request samples

Content type
application/json
{
  • "fields": [
    • "MASTER.FIELD_1",
    • "MASTER.EMAIL",
    • "SCOPE_1.FIELD_1",
    • "SYSTEM.SELLIGENTID"
    ],
  • "filters": [ ],
  • "skip": 1,
  • "take": 1,
  • "order_by": "MASTER.NAME",
  • "order_by_direction": "ASC"
}

Response samples

Content type
application/json
{
  • "fields": [
    • "FIELD1",
    • "MASTER.ID"
    ],
  • "data": [
    • [
      • "RECORD1_FIELD1_VALUE",
      • 1
      ],
    • [
      • "RECORD2_FIELD1_VALUE",
      • 2
      ],
    • [
      • "RECORD3_FIELD1_VALUE",
      • 3
      ]
    ],
  • "result_code": "Succeeded",
  • "errors": [ ]
}

List engagement

All list engagement endpoints

Get List engagement structure

This endpoint will return the engagement list structure for specified channel type for a user list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

channel
required
string
Enum: "Email" "Sms" "Mobile" "Web" "Mms"
Example: Email

Channel type.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (List_Engagement_Structure)

Structure of the list fields.

Array
name
string

Name of the field.

data_type
string (data_type)
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

length
integer or null <int32>

Length of list field.

allow_null
boolean

Flag indicating if the field is nullable or not.

Response samples

Content type
application/json
{
  • "fields": [
    • {
      • "name": "ID",
      • "data_type": "Numeric",
      • "allow_null": false,
      • "length": null
      },
    • {
      • "name": "USERID",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "DELIVERED",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "CLICKED",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "VIEWED",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "DELIVERED_LASTDT",
      • "data_type": "DateTime",
      • "allow_null": true
      },
    • {
      • "name": "VIEWED_LASTDT",
      • "data_type": "DateTime",
      • "allow_null": true
      },
    • {
      • "name": "CLICKED_LASTDT",
      • "data_type": "DateTime",
      • "allow_null": true
      },
    • {
      • "name": "DELIVERY_RATE",
      • "data_type": "Float",
      • "allow_null": true
      },
    • {
      • "name": "VIEW_RATE",
      • "data_type": "Float",
      • "allow_null": true
      },
    • {
      • "name": "CLICK_RATE_CTR",
      • "data_type": "Float",
      • "allow_null": true
      },
    • {
      • "name": "DESKTOP_ENGAGEMENTS",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "MOBILE_ENGAGEMENTS",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "TABLET_ENGAGEMENTS",
      • "data_type": "Numeric",
      • "allow_null": true,
      • "length": null
      },
    • {
      • "name": "MOBILE_USAGE_RATE",
      • "data_type": "Float",
      • "allow_null": true
      },
    • {
      • "name": "TABLET_USAGE_RATE",
      • "data_type": "Float",
      • "allow_null": true
      }
    ]
}

List Engagement data

Get engagement list record data for specified channel type and master list record.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

channel
required
string
Enum: "Email" "Sms" "Mobile" "Web" "Mms"
Example: Email

Channel type.

record_id
required
integer <int32>
Example: 1

Parameter for record id associated with a list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
object

Record data.

ID
integer

ID of the record.

USERID
integer

ID of the user.

DELIVERED
integer

Number of delivered items for this channel.

VIEWED
integer

Number of viewed items for this channel.

CLICKED
integer

Number of Clicked items for this channel.

DELIVERED_LASTDT
string <date-time>

last time user received a message on this channel.

VIEWED_LASTDT
string <date-time>

last time user viewed a message on this channel.

CLICKED_LASTDT
string <date-time>

last time user clicked a message on this channel.

DELIVERY_RATE
integer

Percentage of message on this channel that are delivered to the user.

VIEW_RATE
integer

Percentage of message on this channel that are viewed by the user.

CLICK_RATE_CTR
integer

Percentage of message on this channel that are clicked by the user.

Response samples

Content type
application/json
{
  • "record": {
    • "ID": 1,
    • "USERID": 1,
    • "DELIVERED": 100,
    • "VIEWED": 0,
    • "CLICKED": 0,
    • "DELIVERED_LASTDT": "2023-09-11T10:01:03.01",
    • "VIEWED_LASTDT": "2023-09-12T11:10:03.02",
    • "CLICKED_LASTDT": "2023-09-13T14:25:04.03",
    • "DELIVERY_RATE": 95,
    • "VIEW_RATE": 90,
    • "CLICK_RATE_CTR": 85
    }
}

List field

All list field endpoints

Get list fields

Use this endpoint to get list fields based on API name of list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of any (List_Field)

List of fields to create on the custom event.

Array
name
required
string

Name of the field.

length
integer <int32>
Default: 50

The length of the field.

data_type
required
string
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

description
string
Default: ""

Description about the field.

allow_null
boolean
Default: true

Allow null values for this field.

content
string
Default: "Free"

The type of field stored.

Response samples

Content type
application/json
{
  • "fields": [
    • {
      • "name": "field_1",
      • "length": 50,
      • "data_type": "Text",
      • "description": "This is a field of type text.",
      • "allow_null": false,
      • "content": "Free"
      }
    ]
}

Create list fields

Use this endpoint to create list fields.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of any (List_Field)

List of fields to create on the custom event.

Array
name
required
string

Name of the field.

length
integer <int32>
Default: 50

The length of the field.

data_type
required
string
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

description
string
Default: ""

Description about the field.

allow_null
boolean
Default: true

Allow null values for this field.

content
string
Default: "Free"

The type of field stored.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "fields": [
    • {
      • "allow_null": false,
      • "data_type": "Text",
      • "description": "Some text field",
      • "length": 50,
      • "name": "TextField"
      },
    • {
      • "allow_null": true,
      • "data_type": "Boolean",
      • "description": "Some boolean field",
      • "name": "BooleanField"
      },
    • {
      • "allow_null": true,
      • "data_type": "Date",
      • "description": "Some date field",
      • "name": "DateField"
      },
    • {
      • "allow_null": true,
      • "data_type": "DateTime",
      • "description": "Some date time field",
      • "name": "DateTimeField"
      },
    • {
      • "allow_null": true,
      • "data_type": "Float",
      • "description": "Some float field",
      • "name": "FloatField"
      },
    • {
      • "allow_null": true,
      • "data_type": "Long",
      • "description": "Some long field",
      • "name": "LongField"
      },
    • {
      • "allow_null": true,
      • "data_type": "LongText",
      • "description": "Some long text field",
      • "name": "LongTextField"
      },
    • {
      • "allow_null": true,
      • "data_type": "Numeric",
      • "description": "Some numeric field",
      • "name": "NumericField"
      },
    • {
      • "allow_null": false,
      • "data_type": "Numeric",
      • "description": "Some numeric field",
      • "name": "NumericFieldWithNumericOptionList",
      • "content": "Single",
      • "optionlist": "Optionlist_Numeric_ApiName"
      },
    • {
      • "allow_null": true,
      • "data_type": "Text",
      • "length": 50,
      • "description": "Some text field",
      • "name": "TextFieldWithTextOptionList",
      • "content": "Multi",
      • "optionlist": "Optionlist_Text_ApiName"
      },
    • {
      • "allow_null": true,
      • "data_type": "Boolean",
      • "description": "Some boolean field",
      • "name": "BooleanFieldWithContentFree",
      • "content": "Free"
      },
    • {
      • "allow_null": true,
      • "data_type": "Text",
      • "description": "Some field",
      • "name": "ComputedNonPersistedField",
      • "content": "ComputedNonPersisted",
      • "value_definition": "[%[MASTER.NAME]%]"
      },
    • {
      • "allow_null": true,
      • "data_type": "Text",
      • "description": "Some field",
      • "name": "ComputedPersistedField",
      • "content": "ComputedPersisted",
      • "value_definition": "[%lower( [MASTER.NAME] )%]"
      },
    • {
      • "allow_null": true,
      • "data_type": "Text",
      • "length": 50,
      • "name": "TextFieldWithIdentifiers",
      • "description": "The type Lookup is used for a 'Data Selection Identifiers Set' field",
      • "content": "Lookup"
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Fields created successfully."
}

Update list field

Use this endpoint to update an existing field of list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

name
required
string
Example: storedprocedure_1

Name of the field.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json

Parameter for details containing the new field information.

name
string

Name of the field.

description
string

Description about the field.

content
string

The type of field stored.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
Example
{
  • "name": "field 1",
  • "description": "This is a text field.",
  • "content": "Other"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The field has been updated successfully."
}

Delete list field

Use this endpoint to delete a list field based on list's API name and name of the field

path Parameters
api_name
required
string
Example: list_1

API name of the list.

name
required
string
Example: storedprocedure_1

Name of the field.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "List field deleted successfully."
}

List interest

All list interest endpoints

Get interest structure

This endpoint will return the interest list structure for specified channel type for an user list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

channel
required
string
Enum: "Email" "Sms" "Mobile" "Web" "Mms"
Example: Email

Channel type.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (List_Interest_Structure)

Structure of the list fields.

Array
name
string

Name of the field.

data_type
string (data_type)
Enum: "Unknown" "Boolean" "Numeric" "Long" "Float" "Date" "DateTime" "Text" "LongText" "Json" "UniqueIdentifier"

Data type of the field.

length
integer or null <int32>

Length of list field.

allow_null
boolean

Flag indicating if the field is nullable or not.

Response samples

Content type
application/json
{
  • "fields": [
    • {
      • "name": "ID",
      • "data_type": "Numeric",
      • "allow_null": false
      },
    • {
      • "name": "USERID",
      • "data_type": "Numeric",
      • "allow_null": true
      },
    • {
      • "name": "TOP_TAG_1",
      • "data_type": "Text",
      • "length": 255,
      • "allow_null": true
      },
    • {
      • "name": "TOP_TAG_2",
      • "data_type": "Text",
      • "length": 255,
      • "allow_null": true
      },
    • {
      • "name": "TOP_TAG_3",
      • "data_type": "Text",
      • "length": 255,
      • "allow_null": true
      },
    • {
      • "name": "TOP_TAG_4",
      • "data_type": "Text",
      • "length": 255,
      • "allow_null": true
      },
    • {
      • "name": "TOP_TAG_5",
      • "data_type": "Text",
      • "length": 255,
      • "allow_null": true
      },
    • {
      • "name": "TAG_CLICK_TOTAL",
      • "data_type": "Numeric",
      • "allow_null": true
      }
    ]
}

Get interest record

Use this endpoint to retrieve interest list record data for specified channel type and master list record.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

channel
required
string
Enum: "Email" "Sms" "Mobile" "Web" "Mms"
Example: Email

Channel type.

record_id
required
integer <int32>
Example: 1

Parameter for record id associated with a list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
object

Record data.

ID
integer

ID of the record.

USERID
integer

ID of the user.

TAG_CLICK_TOTAL
integer

Number of total tag clicks for this user.

tag*
additional property
string

the Tag keys. with corresponding values

Response samples

Content type
application/json
{
  • "record": {
    • "ID": 1,
    • "USERID": 1,
    • "TOP_TAG_1": "Tag 1",
    • "TOP_TAG_2": "Tag 2",
    • "TOP_TAG_3": "Tag 3",
    • "TOP_TAG_4": "Tag 4",
    • "TOP_TAG_5": "Tag 5",
    • "TAG_CLICK_TOTAL": 10
    }
}

List record

All list record endpoints

List record count

Use this endpoint to get records count by API name of list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
count
integer <int32>

the count of records in the list.

Response samples

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

Delete record

Use this endpoint to delete single record by its record Id.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

record_id
required
integer <int64>
Example: 4761

Required Parameter to specify if the associated record is to be deleted.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded"
}

List relation

All list relation endpoints

List list relations

Use this endpoint to get all relations associated with a list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "OneToOne" "OneToMany" "ManyToOne"
Example: filter=OneToOne, OneToMany

Filter relations by relation type.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (List_Relation_Base)

list of relations connected to this list.

Array
type
string
Enum: "OneToOne" "OneToMany" "ManyToOne"

The type of the relation.

scope
string

The scope name for a relation.

source_list_api_name
string

API name of the source list.

destination_list_api_name
string

API name of the destination list.

Response samples

Content type
application/json
{
  • "relations": [
    • {
      • "type": "ManyToOne",
      • "scope": "SCOPE_1",
      • "source_list_api_name": "source_list_api_name",
      • "destination_list_api_name": "destination_list_1_api_name"
      },
    • {
      • "type": "OneToMany",
      • "scope": "SCOPE_2",
      • "source_list_api_name": "source_list_api_name",
      • "destination_list_api_name": "destination_list_2_api_name"
      }
    ]
}

Create list relations

Use this endpoint to create relations between 2 lists.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of objects
Array
scope
required
string

Name of the relation.

type
required
string
Enum: "OneToOne" "OneToMany" "ManyToOne"

Type of the relation.

masterlist_field_name
required
string

Field name of master list.

slavelist_api_name
required
string

API name of extension list.

slavelist_field_name
required
string

Field name of the extension list.

Array of objects (List_Relation_Constraint_2)

Constraints of the relation.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "relations": [
    • {
      • "type": "OneToMany",
      • "scope": "SCOPE1",
      • "masterlist_field_name": "masterlist_field_name",
      • "slavelist_api_name": "slavelist_api_name",
      • "slavelist_field_name": "slavelist_field_name",
      • "constraints": [
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": null,
  • "errors": [ ]
}

Get list relation

Use this endpoint to get relation details based on API name of the list and name of the relation.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

scope
required
string
Example: RELATION_1

Scope name of the relation.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
scope_name
string

Name of the relation.

relation_type
string
Enum: "OneToOne" "OneToMany" "ManyToOne"

Type of the relation.

master_list_api_name
string

API name of master list.

master_list_field_name
string

Field name of master list.

slave_list_api_name
string

API name of extension list.

slave_list_field_name
string

Field name of the extension list.

Array of objects (List_Relation_Constraint)

Constraints of the relation.

Array
source_list
string

Source list for constraint.

source_field
string

Source field for constraint.

operator
string
Enum: "Unknown" "EqualTo" "NotEqualTo" "GreaterThan" "GreaterThanOrEqualTo" "LessThan" "LessThanOrEqualTo" "Like" "IsNull" "IsNotNull" "IsEmpty" "IsNotEmpty"

Operator on the constraint.

destination_list
string or null

Destination list for constraint.

destination_field
string or null

Destination field for constraint.

field_value
string or null

Value of source field of the constraint.

Response samples

Content type
application/json
{
  • "scope_name": "RELATION",
  • "relation_type": "OneToMany",
  • "master_list_api_name": "master_list",
  • "master_list_field_name": "master_field",
  • "slave_list_api_name": "extension_list",
  • "slave_list_field_name": "extension_field",
  • "constraints": [
    • {
      • "source_list": "MASTER",
      • "source_field": "master_field",
      • "operator": "EqualTo",
      • "destination_list": "EXTENSION",
      • "destination_field": "extension_field",
      • "field_value": null
      },
    • {
      • "source_list": "MASTER",
      • "source_field": "master_field",
      • "operator": "EqualTo",
      • "destination_list": null,
      • "destination_field": null,
      • "field_value": "10"
      }
    ]
}

Update list relation

Use this endpoint to update an existing relation between the given list and a linked list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

scope
required
string
Example: RELATION_1

Scope name of the relation.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json

Object to specify updates to a relation. Partial updates are allowed; omit properties you do not wish to update.

scope
string or null
Default: null

Name of the relation.

type
string or null
Default: null
Enum: null "OneToOne" "OneToMany" "ManyToOne"

Type of the relation.

masterlist_field_name
string or null
Default: null

Field name of master list.

slavelist_api_name
string or null
Default: null

API name of extension list.

slavelist_field_name
string or null
Default: null

Field name of the extension list.

Array of objects or null (List_Relation_Constraint_2)
Default: null

Constraints of the relation. You must either leave this empty to retain the original constraints, or specify all constraints you wish for the relation to contain.

Array
list1
required
string
Enum: "MASTER" "EXTENSION"

Source list for constraint.

field1
required
string

Source field for constraint.

operator
required
string
Enum: "Unknown" "EqualTo" "NotEqualTo" "GreaterThan" "GreaterThanOrEqualTo" "LessThan" "LessThanOrEqualTo" "Like" "IsNull" "IsNotNull" "IsEmpty" "IsNotEmpty"

Operator on the constraint.

Expand for more info:
  • Unknown: Invalid. Do not use this.

Compare source field to destination field or fixed value:

  • EqualTo
  • NotEqualTo
  • GreaterThan
  • GreaterThanOrEqualTo
  • LessThan
  • LessThanOrEqualTo

Compare source field to a fixed value:

  • Like: Requires value. This constraint is true if the source field contains the value.

Constraint applies only to field1. Do not specify list2, field2 or value:

  • IsNull: Returns true if the field1 is (database) null. This will be false if field1 contains an empty string or 0.
  • IsNotNull: Inverse of the above.
  • IsEmpty: Returns true if field1 is empty. This can be null, an empty string or 0.
  • IsNotEmpty: Inverse of the above.
list2
string
Enum: null "MASTER" "EXTENSION"

Destination list for constraint. Mutually exclusive with value. Fill in list2 and field2 to compare the source field to this destination field.

field2
string

Destination field for constraint. Mutually exclusive with value. Fill in list2 and field2 to compare the source field to this destination field.

value
string

Value of source field of the constraint. Mutually exclusive with list2 and field2. Fill in value to compare the source field to this fixed value.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "scope": "NEW_RELATION_NAME"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The relation was successfully updated.",
  • "errors": [ ]
}

Delete list relation

Use this endpoint to delete a relation between this list and another.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

scope
required
string
Example: RELATION_1

Scope name of the relation.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The relation has been deleted successfully",
  • "errors": [ ]
}

List segment

All list relation endpoints

Get list segments

Get an overview of the segments defined on the given list.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "Static" "Dynamic" "External" "Unknown"
Example: filter=Static,Dynamic

Filter segment by type.

take
integer <int32>
Default: -1
Example: take=50

The maximum amount of items to return.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects

Collection of segments under this list matching the Criteria.

Array
api_name
string

Segment API name.

segment_type
string (type-4)
Enum: "Unknown" "Dynamic" "Static" "External"

Type of the segment.

Response samples

Content type
application/json
{
  • "segments": [
    • {
      • "segment_type": "Dynamic",
      • "api_name": "segment_1"
      },
    • {
      • "segment_type": "External",
      • "api_name": "segment_2"
      }
    ]
}

Get list segment

Use this endpoint to get segment details based on list API name and segment API name.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

Segment API name.

type
string
Enum: "Unknown" "Dynamic" "Static" "External"

Type of the segment.

name
string

Name of the segment.

description
string

Description of the segment.

Response samples

Content type
application/json
{
  • "api_name": "segment_1",
  • "type": "string",
  • "name": "Segment 1",
  • "description": "My first segment"
}

Delete list segment

Use this endpoint to delete a segment by its API name in the given organization.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The segment has been deleted successfully"
}

Create static segment

Create static segment based on list API name and provided segment info parameters.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

Segment API name.

name
required
string

Name of the segment.

description
string

Description of the segment.

folder
string

Folder path to store the segment in.

tags
Array of strings (tags)
Default: []

Labels of the object.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "segment_1",
  • "name": "Segment 1",
  • "description": "My first segment",
  • "folder": "folder_1",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The static segment has been created successfully."
}

Delete data from a static segment

Use this endpoint to delete data from a specific static segment.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
keyFields
required
string
Example: keyFields=key1,key2,key3

A comma-separated list of the key fields that need to be used.

fields
string
Default: null
Example: fields=field1,field2

A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.

mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

deduplication
string
Default: "ImportLastMatch"
Enum: "None" "ImportLastMatch" "ImportFirstMatch"
Example: deduplication=ImportLastMatch

The de-duplication option to use.

errorHandling
string
Default: "StopOnError"
Enum: "None," "StopOnError," "ContinueOnError,"
Example: errorHandling=ContinueOnError

Parameter indicates error handling options whether to stop on error or continue on error.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

result_code
string
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Indicates the resultCode for the request.

number_of_duplicate_records
integer <int64>

When the data deletion succeeded, this property contains the number of duplicate records

number_of_failed_records
integer <int64>

When the data deletion partially succeeded, this property contains the number of failed records

number_of_records_not_found
integer <int64>
Array of objects or null (Data_Load_Invalid)

When the data deletion partially succeeded, this property contains information about the invalid records

Array
record_index
integer <int32>

Index of the invalid record.

field_name
string

Name of the field that contains the invalid data, if applicable.

message
string

Message containing information about the error.

validation_code
string
Enum: "Unknown" "InvalidFieldCount" "MaxStringLengthExceeded" "InvalidType"

Validation code indicating the error.

number_of_deleted_records
integer <int64>

When the data deletion succeeded, this property contains the number of deleted records

Response samples

Content type
application/json
{
  • "result_code": "PartiallySucceeded",
  • "number_of_deleted_records": 48,
  • "number_of_duplicate_records": 0,
  • "number_of_failed_records": 2,
  • "number_of_records_not_found": 0,
  • "invalid_records": [
    • {
      • "record_index": 17,
      • "message": "Record contains incorrect number of fields",
      • "validation_code": "InvalidFieldCount"
      }
    ]
}

Clear Static segment data

Use this endpoint to clear static segment data.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The data has been cleared successfully."
}

Create / Update data static segment

Use this endpoint to load data into a specific static segment.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
keyFields
required
string
Example: keyFields=key1,key2,key3

A comma-separated list of the key fields that need to be used.

fields
string
Default: null
Example: fields=field1,field2

A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.

mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

deduplication
string
Default: "ImportLastMatch"
Enum: "None" "ImportLastMatch" "ImportFirstMatch"
Example: deduplication=ImportLastMatch

The de-duplication option to use.

errorHandling
string
Default: "StopOnError"
Enum: "None," "StopOnError," "ContinueOnError,"
Example: errorHandling=ContinueOnError

Parameter indicates error handling options whether to stop on error or continue on error.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

result_code
string
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Indicates the resultCode for the request.

number_of_duplicate_records
integer <int64>

When the data deletion succeeded, this property contains the number of duplicate records

number_of_failed_records
integer <int64>

When the data deletion partially succeeded, this property contains the number of failed records

number_of_records_not_found
integer <int64>
Array of objects or null (Data_Load_Invalid)

When the data deletion partially succeeded, this property contains information about the invalid records

Array
record_index
integer <int32>

Index of the invalid record.

field_name
string

Name of the field that contains the invalid data, if applicable.

message
string

Message containing information about the error.

validation_code
string
Enum: "Unknown" "InvalidFieldCount" "MaxStringLengthExceeded" "InvalidType"

Validation code indicating the error.

number_of_inserted_records
integer <int64>

When the data load succeeded, this property contains the number of inserted records

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "result_code": "PartiallySucceeded",
  • "number_of_inserted_records": 50,
  • "number_of_failed_records": 2,
  • "number_of_updated_records": 48,
  • "number_of_duplicate_records": 0,
  • "number_of_records_not_found": 0,
  • "invalid_records": [
    • {
      • "record_index": 10,
      • "field_name": "SOMESTRING",
      • "message": "Length of string (53) exceeds maximum field length (50)",
      • "validation_code": "MaxStringLengthExceeded"
      },
    • {
      • "record_index": 17,
      • "message": "Record contains incorrect number of fields",
      • "validation_code": "InvalidFieldCount"
      }
    ],
  • "number_of_deleted_records": 0
}

Search List Segment records

Use this endpoint to search for data records within a segment of a specific table.\r\nSearching data can be done synchronous or streamed.\r\nThe data in the response will be in a Json format.

path Parameters
api_name
required
string
Example: list_1

API name of the list.

segment_api_name
required
string
Example: api_name_segment

API name of the segment.

organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
mode
string
Default: "Sync"
Enum: "Sync" "Stream"

The mode of data transfer.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
fields
required
Array of strings

An array of fields to be returned for a record.

Array of objects (Data_Search_Filter)

filters to apply for the search. Works as an AND.

Array
field_name
string

Name of the field to check against.

operator
string
Enum: "Unknown" "EqualTo" "NotEqualTo" "GreaterThan" "GreaterThanOrEqualTo" "LessThan" "LessThanOrEqualTo" "Like" "IsNull" "IsNotNull" "IsEmpty" "IsNotEmpty"
field_value
string

the value to compaire against.

skip
integer <int32>

The index to start from, skipping all the previous results.

take
integer <int32>

The maximum amount of items to return.

order_by
string

Field to order the results on.

order_by_direction
string
Enum: "ASC" "DESC"

Irdening direction of the results.

Responses

Response Schema: application/json
fields
Array of strings

An array of fields to be returned for a record.

Array of objects (error)

In case deleting the data fails, this property contains the list of validation errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

data
Array of arrays

List of records

result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Request samples

Content type
application/json
{
  • "fields": [
    • "MASTER.FIELD1",
    • "FIELD2",
    • "SCOPE.FIELD_X",
    • "SYSTEM.SELLIGENTID"
    ],
  • "filters": [
    • {
      • "field_name": "MASTER.FIELD1",
      • "operator": "EqualTo",
      • "field_value": "VALUE"
      }
    ],
  • "skip": 20,
  • "take": 20,
  • "order_by": "MASTER.FIELD2",
  • "order_by_direction": "ASC"
}

Response samples

Content type
application/json
{
  • "fields": [
    • "MASTER.FIELD_1",
    • "MASTER.EMAIL",
    • "SCOPE_1.FIELD_1",
    • "SYSTEM.SELLIGENTID"
    ],
  • "errors": [
    • {
      • "error_code": "Failed",
      • "description": "Message with api name 'message_1' doesn't exists"
      }
    ],
  • "data": [
    • [
      • "RECORD1_FIELD1_VALUE",
      • 1
      ]
    ],
  • "result_code": "PartiallySucceeded"
}

Data Import

All data import endpoints

Delete data import

Use this endpoint to delete a data import.

path Parameters
api_name
required
string
Example: data_export_1

API name of the data import.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Data import has been deleted successfully.",
  • "errors": [ ]
}

Data Export

All data export endpoints

Delete data export

Use this endpoint to delete a data export.

path Parameters
api_name
required
string
Example: data_export_1

API name of the data export.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Data export has been deleted successfully.",
  • "errors": [ ]
}

CIM

All cim endpoints

Create CIM collect request

Create a request to collect customer(s) information in the specified list, based on the provided filters.

path Parameters
api_name
required
string
Example: user_list_1

API name of the user list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of objects (CIM_Filter)

List of filters to apply.

Array
field
required
string

Field on the user list to filter on.

value
required
string

Value of the field to filter on.

Responses

Response Schema: application/json
id
integer

The ID of the request.

Request samples

Content type
application/json
{
  • "filters": [
    • {
      • "field": "email",
      • "value": "user@gmail.xyz"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": 123
}

Create CIM optout request

Create a request to optout customer(s) in the specified list, based on the provided filters.

path Parameters
api_name
required
string
Example: user_list_1

API name of the user list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of objects (CIM_Filter)

List of filters to apply.

Array
field
required
string

Field on the user list to filter on.

value
required
string

Value of the field to filter on.

Responses

Response Schema: application/json
id
integer

The ID of the request.

Request samples

Content type
application/json
{
  • "filters": [
    • {
      • "field": "email",
      • "value": "user@gmail.xyz"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": 123
}

Create CIM remove request

Create a request to remove customer(s) information in the specified list, based on the provided filters.

path Parameters
api_name
required
string
Example: user_list_1

API name of the user list.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
required
Array of objects (CIM_Filter)

List of filters to apply.

Array
field
required
string

Field on the user list to filter on.

value
required
string

Value of the field to filter on.

Responses

Response Schema: application/json
id
integer

The ID of the request.

Request samples

Content type
application/json
{
  • "filters": [
    • {
      • "field": "email",
      • "value": "user@gmail.xyz"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": 123
}

Get CIM request payload

path Parameters
requestId
required
string
Example: 1

Id of the Customer information Management request.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
id
integer

The ID of the request.

Response samples

Content type
application/json
{
  • "id": 123
}

Cancel CIM request

path Parameters
requestId
required
string
Example: 1

Id of the Customer information Management request.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
id
integer

The ID of the request.

Response samples

Content type
application/json
{
  • "id": 123
}

Get state of CIM request

path Parameters
requestId
required
string
Example: 1

Id of the Customer information Management request.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
state
string
Enum: "New" "Failed" "NoMatch" "Finished" "Pending"

State of the request.

Response samples

Content type
application/json
{
  • "state": "Finished"
}

Notification Group

All notification group endpoints

List notification groups

Retrieve all the notification groups.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Notification_Group_Base)

List of notification groups defined.

Array
api_name
string

API name of the notification group.

Response samples

Content type
application/json
{
  • "notification_groups": [
    • {
      • "api_name": "notification_group_1"
      }
    ]
}

Create notification group

Create a new notification group.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string

API name of the notification group.

name
string

Name of the notification group.

email_addresses
Array of strings

list of recipients of the notification group.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "notification_group_1",
  • "name": "Notification Group 1",
  • "email_addresses": [
    • "john.doe@example.com",
    • "john.doe1@example.com"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Notification group saved successfully."
}

Get notification group

Get the details of the notification group with given API name.

path Parameters
api_name
required
string
Example: notification_group_1

API name of the notification group.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

API name of the notification group.

name
string

Name of the notification group.

email_addresses
Array of strings

list of recipients of the notification group.

users
Array of strings

list of users linked to this notification group.

Response samples

Content type
application/json
{
  • "api_name": "notification_group_1",
  • "name": "Notification Group 1",
  • "email_addresses": [
    • "john.doe@example.com",
    • "john.doe1@example.com"
    ],
  • "users": [
    • "John Doe",
    • "Johanna Doe"
    ]
}

Update notification group

Update the properties of the given notification group.

path Parameters
api_name
required
string
Example: notification_group_1

API name of the notification group.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string

API name of the notification group.

name
string

Name of the notification group.

email_addresses
Array of strings

list of recipients of the notification group.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "notification_group_1",
  • "name": "Notification Group 1",
  • "email_addresses": [
    • "john.doe@example.com",
    • "john.doe1@example.com"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Notification group saved successfully."
}

Delete notification group

Delete a notification group.

path Parameters
api_name
required
string
Example: notification_group_1

API name of the notification group.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Notification group deleted successfully."
}

Stored Procedure

All stored procedures endpoints

List stored procedures

List stored procedures satisfying the provided criteria, under the provided organization.

query Parameters
filter
string
Enum: "General" "Bounce"
Example: filter=General

Filter stored procedures by type.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Stored_Procedure_Base)

List of stored procedures defined matching the given criteria.

Array
type
string
Enum: "Unknown" "General" "Bounce"

Type of the stored procedure.

name
string

Name of the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

Response samples

Content type
application/json
{
  • "stored_procedures": [
    • {
      • "type": "Bounce",
      • "name": "ST_1"
      }
    ]
}

Create stored procedure

Create a new stored procedure in the organization.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
type
required
string
Enum: "Unknown" "General" "Bounce"

Type of the stored procedure.

name
required
string

Name of the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

description
string

A Description explaining this stored procedure.

body
required
string

The to be executed code for this stored procedure.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "type": "Bounce",
  • "name": "ST_1",
  • "description": "General Stored Procedure",
  • "body": "SELECT 'some result' as RESULT;"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Stored procedure created successfully.",
  • "errors": [ ]
}

Get stored procedure

Get details of stored procedure by the specified name.

path Parameters
name
required
string
Example: storedprocedure_1

Name of the stored procedure.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
type
string
Enum: "Unknown" "General" "Bounce"

Type of the stored procedure.

name
string

Name of the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

description
string

A Description explaining this stored procedure.

body
string

The to be executed code for this stored procedure.

Response samples

Content type
application/json
{
  • "type": "Bounce",
  • "name": "ST_1",
  • "description": "General Stored Procedure",
  • "body": "SELECT 'some result' as RESULT;"
}

Update stored procedure

Update an existing stored procedure.

path Parameters
name
required
string
Example: storedprocedure_1

Name of the stored procedure.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
description
string

A Description explaining this stored procedure.

body
string

The to be executed code for this stored procedure.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "description": "General Stored Procedure",
  • "body": "SELECT 'some result' as RESULT;"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Stored procedure updated successfully.",
  • "errors": [ ]
}

Delete stored procedure

Delete a existing stored procedure.

path Parameters
name
required
string
Example: storedprocedure_1

Name of the stored procedure.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The stored procedure has been deleted successfully.",
  • "errors": [ ]
}

Task

All task endpoints

List tasks

Get list of tasks based on the provided criteria, in the provided organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "Sql" "Import" "Export" "Batch"
Example: filter=Import,Export

Filter by task type. Leave empty to return all available task types.

search
string
Default: null
Example: search=marigold_1

Search with a specific name or description. Leave empty to return everything.

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: -1
Example: take=50

The maximum amount of items to return. Use a negative value to retrieve all available items. Used only if skip is non-negative.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Task_Base)

List of tasks matching the criteria.

Array
type
string
Enum: "Unknown" "Sql" "Export" "Import" "Batch"

The type of the task.

api_name
string

The API name for a task.

Response samples

Content type
application/json
{
  • "tasks": [
    • {
      • "type": "Batch",
      • "api_name": "task_1"
      }
    ]
}

Get task

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
type
string
Enum: "Unknown" "Sql" "Export" "Import" "Batch"

The type of the task.

api_name
string

The API name for a task.

name
string

Name of the task.

description
string

Description about the task.

tags
Array of strings (tags)
Default: []

Labels of the object.

execution_status
string
Enum: "Failed" "Success" "Running" "None"

Status of last execution of task.

last_execution
string <date-time>

Last Execution Date of the task.

next_execution
string <date-time>

Next Execution Date of the task.

Response samples

Content type
application/json
{
  • "type": "Batch",
  • "api_name": "task_1",
  • "name": "Task 1",
  • "description": "A very nice task.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "execution_status": "Running",
  • "last_execution": "2023-12-14T11:11:18.3086+01:00",
  • "next_execution": "2023-12-16T11:11:18.3086+01:00",
  • "schedule": { }
}

Delete task

Delete task with the given api name, if it exists in the given organization.

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The task has been deleted successfully",
  • "errors": [ ]
}

List task actions

Get actions of an existing task.

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
taskaction
Array of strings
Items Enum: "Run" "Enable" "Disable"

The available actions for the task.

Response samples

Content type
application/json
{
  • "taskaction": [
    • "Run",
    • "Enable"
    ]
}

Disable task

Disable an existing Task.

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task disabled successfully",
  • "errors": [ ]
}

Enable task

Enable an existing Task.

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task enabled successfully.",
  • "errors": [ ]
}

Run task

Run an existing Task

path Parameters
api_name
required
string
Example: task_1

API name of the task.

organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task has run successfully",
  • "errors": [ ]
}

Create batch task

Create a new task of type batch.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
enable_after_creation
boolean
Default: false
Example: enable_after_creation=true

Define if the task should be enabled after its creation.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

The API name for a task.

name
required
string

Name of the task.

description
string

Description about the task.

tags
Array of strings (tags)
Default: []

Labels of the object.

scheduler
integer <int32>
Default: 0

Id of the scheduler to use.

any
start_date
string <date-time>
Default: null

Start date for the schedule. When not specified, the schedule would immediately be active.

end_date
string <date-time>
Default: null

End date of the schedule. When not specified, the schedule will remain active until the end of time.

schedule_type
required
string

interval on which this schedule should run.

required
Array of objects (Task_Notification)

Configure which execution statuses should result in a notification being sent. At most one entry may be given per type. A notification for type=Failure is mandatory.

Array
type
required
string
Enum: "Unknown" "NoFile" "Error" "Failure" "Complete"

State for which this notification should trigger.

  • NoFile: Failed due to a missing file.
  • Error: Task succeeded with errors.
  • Failure: Task failed.
  • Complete: Task succeeded.
groups
Array of strings

API names of the notification groups that should be informed when this state occurs. Notification groups are configured in the Admin Configuration under Access Management. It is mandatory to list at least one notification group or at least one email.

emails
Array of strings

Email address of recipients that should be informed when this state occurs. It is mandatory to list at least one notification group or at least one email.

include_process_details
boolean
Default: false

provide process details in the notification.

folder
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

required
Array of objects (Task_Batch)
Array
id
required
integer <int32>

Choose a unique positive integer as id for this task within this batch. This ID can be referred to from the on_success or on_fail of other tasks in this same batch.

Only one task may exist where its id isn't referred to from any other task. That task will be the first task to be executed in this batch.

api_name
required
string

API name of the task.

on_success
required
integer <int32>

If this task ran successfully, then run the on_success task. This must be

  • the id of another task in this batch,
  • 0 to halt execution and consider the batch a success or
  • -1 to halt execution and consider the batch a failure.
on_fail
required
integer <int32>

If this task failed, then run the on_fail task. This must be

  • the id of another task,
  • 0 to halt execution and consider the batch a success or
  • -1 to halt execution and consider the batch a failure.
type
string
Enum: "Unknown" "Task" "Import" "Export"

Type of the task.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "task_1",
  • "name": "Task 1",
  • "description": "A very nice task.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "scheduler": 0,
  • "schedule": { },
  • "notifications": [
    • {
      • "type": "Complete",
      • "groups": [
        ],
      • "emails": [
        ],
      • "include_process_details": false
      }
    ],
  • "folder": "106",
  • "tasks": [
    • {
      • "id": 1,
      • "api_name": "task_1",
      • "on_success": 2,
      • "on_fail": 3,
      • "type": "Export"
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task task_name created successfully.",
  • "errors": [ ]
}

Create export task

Create a new task of type export.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
enable_after_creation
boolean
Default: false
Example: enable_after_creation=true

Define if the task should be enabled after its creation.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

The API name for a task.

name
required
string

Name of the task.

description
string

Description about the task.

tags
Array of strings (tags)
Default: []

Labels of the object.

scheduler
integer <int32>
Default: 0

Id of the scheduler to use.

any
start_date
string <date-time>
Default: null

Start date for the schedule. When not specified, the schedule would immediately be active.

end_date
string <date-time>
Default: null

End date of the schedule. When not specified, the schedule will remain active until the end of time.

schedule_type
required
string

interval on which this schedule should run.

required
Array of objects (Task_Notification)

Configure which execution statuses should result in a notification being sent. At most one entry may be given per type. A notification for type=Failure is mandatory.

Array
type
required
string
Enum: "Unknown" "NoFile" "Error" "Failure" "Complete"

State for which this notification should trigger.

  • NoFile: Failed due to a missing file.
  • Error: Task succeeded with errors.
  • Failure: Task failed.
  • Complete: Task succeeded.
groups
Array of strings

API names of the notification groups that should be informed when this state occurs. Notification groups are configured in the Admin Configuration under Access Management. It is mandatory to list at least one notification group or at least one email.

emails
Array of strings

Email address of recipients that should be informed when this state occurs. It is mandatory to list at least one notification group or at least one email.

include_process_details
boolean
Default: false

provide process details in the notification.

folder
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

object (Task_Export_Data_Source)

Data source for the export.

include_selligent_id_column
boolean
Default: false

Add an additional column to the exported data containing a unique ID to identify the exported record.

selligent_id_column
string

If include_selligent_id_column=true, this is the name of the column to be added to the exported data.

sp_name
required
string

A name for the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

object (Task_Stored_Procedure_Fail_Constraint)

Define when a stored procedure should be considered to have failed based on its returned value.

Array of objects (Task_Stored_Procedure_Parameter_Value)

Input parameters for the stored procedure.

required
object (Task_Export_Output)
file_name
required
string

Name of the file.

required
object (Task_Export_File_Options)

file options to use.

object (Task_Advanced_Options)
include_sequence_number
boolean
Default: false

Include a column with the sequence number.

sequence_number
integer <int32>
Default: 0

Sequence number to start from.

overwrite_existing_file
boolean
Default: true

Overwrite if a file already exists in the target folder.

no_data_handling
string
Default: "Continue"
Enum: "Unknown" "Continue" "Skip" "Fail"

What to do in case there is no data to export.

object (Task_Export_Trigger_File)
Default: null

This configures exporting to a secondary file that could be used to inform external processes that your export has completed. If not specified, this secondary export will not be performed.

object (Task_Export_Data_Source)

Data source for the export.

extension
required
string

extension to use.

object (Task_Export_File_Options)

file options to use.

object (Task_Export_Zip_Encrypt)

Encryption or zip mode to use.

mode
string
Enum: "Unknown" "Zip" "Encrypt" "ZipAndEncrypt" "EncryptAndZip"

What to do with the file.

object
object

Pretty Good Privacy encryption definition.

destination
required
string

the API name of the medium to target for this export.

subfolder
string

the subfolder in the destination for the export.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "task_1",
  • "name": "Task 1",
  • "description": "A very nice task.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "scheduler": 0,
  • "schedule": { },
  • "notifications": [
    • {
      • "type": "Complete",
      • "groups": [
        ],
      • "emails": [
        ],
      • "include_process_details": false
      }
    ],
  • "folder": "106",
  • "data_source": {
    • "include_selligent_id_column": true,
    • "selligent_id_column": "column_1",
    • "sp_name": "ST_1.",
    • "fail_constraint": {
      • "operator": "EqualTo",
      • "value": 5
      },
    • "parameter_values": [
      • {
        }
      ]
    },
  • "output": {
    • "file_name": "file_1",
    • "file_options": {
      • "encoding": "X_MAC_CE",
      • "delimiter": ";",
      • "use_text_quotes": true,
      • "first_line_has_column_names": true,
      • "max_file_size": 100,
      • "line_break": "Windows",
      • "skip_bom": false
      }
    },
  • "options": {
    • "include_sequence_number": true,
    • "sequence_number": 5,
    • "overwrite_existing_file": false,
    • "no_data_handling": "Skip"
    },
  • "trigger_file": null,
  • "zip_and_encrypt": {
    • "mode": "Zip",
    • "zip_archive": {
      • "generate_file_name": false,
      • "file_name": "file.zip"
      },
    • "pgp_encryption": {
      • "recipient": "sec@meetmarigold.com"
      }
    },
  • "destination": "medium_1",
  • "subfolder": "exports"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task task_name created successfully.",
  • "errors": [ ]
}

Create import task

Create a new task of type import.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
enable_after_creation
boolean
Default: false
Example: enable_after_creation=true

Define if the task should be enabled after its creation.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

The API name for a task.

name
required
string

Name of the task.

description
string

Description about the task.

tags
Array of strings (tags)
Default: []

Labels of the object.

scheduler
integer <int32>
Default: 0

Id of the scheduler to use.

any
start_date
string <date-time>
Default: null

Start date for the schedule. When not specified, the schedule would immediately be active.

end_date
string <date-time>
Default: null

End date of the schedule. When not specified, the schedule will remain active until the end of time.

schedule_type
required
string

interval on which this schedule should run.

required
Array of objects (Task_Notification)

Configure which execution statuses should result in a notification being sent. At most one entry may be given per type. A notification for type=Failure is mandatory.

Array
type
required
string
Enum: "Unknown" "NoFile" "Error" "Failure" "Complete"

State for which this notification should trigger.

  • NoFile: Failed due to a missing file.
  • Error: Task succeeded with errors.
  • Failure: Task failed.
  • Complete: Task succeeded.
groups
Array of strings

API names of the notification groups that should be informed when this state occurs. Notification groups are configured in the Admin Configuration under Access Management. It is mandatory to list at least one notification group or at least one email.

emails
Array of strings

Email address of recipients that should be informed when this state occurs. It is mandatory to list at least one notification group or at least one email.

include_process_details
boolean
Default: false

provide process details in the notification.

folder
string <int64> (folder_id)

Folder ID. The root folder has ID 0.

trigger_journey_after_execution
string
Default: null

API name of a journey to trigger after this task completes successfully. Leave empty to not trigger any journey.

object

Trigger a custom event after this task completes successfully. Leave empty to not trigger any custom event.

list
required
string

API name of the list.

custom_event
required
string

API name of the custom event on the given list.

required
Array of any

Mapping information for the different columns. At least one mapping must be specified.

Array
name
required
string

Name of the column.

type
required
string

the type of data that is in the column.

object (Task_import_Processing_Folders)

the different folders to store info in based on the result.

processing
required
string

Folder when the processing is in progress.

completed
required
string

Folder when the processing is completed.

failed
required
string

Folder when processing failed.

object (Task_Stored_Procedure)
sp_name
required
string

A name for the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

object (Task_Stored_Procedure_Fail_Constraint)

Define when a stored procedure should be considered to have failed based on its returned value.

Array of objects (Task_Stored_Procedure_Parameter_Value)

Input parameters for the stored procedure.

object (Task_Import_Reject_Management)

Export rejected records. If not configured, these records will be ignored.

destination
required
string

API name of the medium to use when the import is rejected.

subfolder
string
Default: ""

subfolder to store the file in.

object (Task_Import_File_Options)

file options to use.

create_when_no_records_rejected
boolean
Default: false

Create a reject export even if no records have been rejected.

object (Task_Import_Advanced_Options)
file_filter
string
Default: ""

Filter to use to get the relevant file(s).

trigger_file
string
Default: ""

Only execute this import if a file with this extension and the same name as the to be imported file exists.

For example, say your import is configured to import all files that match *.csv and uses trg as trigger_file. If your data source contains these files:

  • file1.csv
  • file1.trg
  • file2.csv

Then, due to the trigger file requirement, only file1.csv will be processed. file2.csv will be ignored until a file file2.trg is present.

allow_multiple_imports
boolean
Default: false

Allow multiple imports of the same file. Normally, the import process keeps track of the name of the files it has imported already and will not import a file with the same name again. This property can be used to disable this.

fail_if_no_file
boolean
Default: false

Fail the import if we cannot find a file.

fail_if_empty_file
boolean
Default: false

Fail the import if the file is empty.

delete_after_processing
boolean
Default: true

Deleted the file once processing is done.

process_files_one_by_one
boolean
Default: false

Process files all at once or one-by-one.

invalid_data_handling
string
Default: "Reject"
Enum: "Unknown" "Stop" "Keep" "Skip" "Reject"

Action to take when data is invalid.

object (Task_Import_Unzip_Decrypt)

Decryption or unpackaging mode to use.

mode
string
Enum: "Unknown" "Unzip" "Decrypt" "UnzipAndDecrypt" "DecryptAndUnzip"

How to unpack the file..

unzip_filter
string

file extension to filter on in the server.

object

Pretty Good Privacy definitioncryption definition.

required
object (Task_Import_Destination)
table_name
required
string

Table name in the Engage SQL database to import data into.

include_user_identified_column
boolean
Default: false

Adds an INT column MAID to the imported table. Your import procedure could use this column to store the ID of a record it matches against.

subfolder
string

the subfolder in the destination for the export.

source
required
string

the API name of the medium to use for this import.

file_type
required
string

File type to be imported.

object (Task_Import_File_Options)

file options to use.

encoding
string (encoding)
Default: "UTF_8"
Enum: "Unknown" "BIG5" "CP866" "CP875" "EUC_JP" "EUC_KR" "GB2312" "IBM037" "IBM1026" "IBM290" "IBM437" "IBM500" "IBM737" "IBM775" "IBM850" "IBM852" "IBM855" "IBM857" "IBM860" "IBM861" "IBM863" "IBM865" "IBM869" "ISO_2022_JP" "ISO_8859_1" "ISO_8859_13" "ISO_8859_15" "ISO_8859_2" "ISO_8859_4" "ISO_8859_5" "ISO_8859_7" "ISO_8859_9" "JOHAB" "KOI8_R" "KOI8_U" "KS_C_5601_1987" "MACINTOSH" "UNICODEFFFE" "US_ASCII" "UTF_16" "UTF_8" "WINDOWS_1250" "WINDOWS_1251" "WINDOWS_1252" "WINDOWS_1253" "WINDOWS_1254" "WINDOWS_1255" "WINDOWS_1256" "WINDOWS_1257" "WINDOWS_1258" "WINDOWS_874" "X_CHINESE_CNS" "X_CP20261" "X_CP20936" "X_CP20949" "X_CP21027" "X_MAC_CE" "X_MAC_CHINESESIMP" "X_MAC_CHINESETRAD" "X_MAC_CROATIAN" "X_MAC_CYRILLIC" "X_MAC_GREEK" "X_MAC_ICELANDIC" "X_MAC_JAPANESE" "X_MAC_KOREAN" "X_MAC_ROMANIAN" "X_MAC_TURKISH" "X_MAC_UKRAINIAN"

Specify the file encoding.

delimiter
string
Default: ";"

delimiter to use.

use_text_quotes
boolean
Default: false

qoute all values.

first_line_has_column_names
boolean
Default: true

specify if file should be with column names or without.

max_file_size
integer <int32>
Default: 0

Max file size in MB before a new file should be written. Unlimited filesize if no positive value is set.

line_break
string
Default: "Windows"
Enum: "Unknown" "Windows" "Unix"

type of line break to use.

check_md5
boolean
Default: false

Define if we need to check MD5.

max_column_count
integer <int32>
Default: 0

Max number of columns to allow.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
Example
{
  • "api_name": "task_1",
  • "name": "Task 1",
  • "description": "A very nice task.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "scheduler": 0,
  • "schedule": { },
  • "notifications": [
    • {
      • "type": "Complete",
      • "groups": [
        ],
      • "emails": [
        ],
      • "include_process_details": false
      }
    ],
  • "folder": "106",
  • "trigger_journey_after_execution": "journey_1",
  • "trigger_custom_event_after_execution": {
    • "list": "list_1",
    • "custom_event": "custom_event_1"
    },
  • "column_mapping": [
    • {
      • "name": "column_1",
      • "type": "Text"
      }
    ],
  • "processing_folders": {
    • "processing": "Processing Folder",
    • "completed": "Completion Folder",
    • "failed": "Failed Folder"
    },
  • "data_processing": {
    • "sp_name": "ST_1.",
    • "fail_constraint": {
      • "operator": "EqualTo",
      • "value": 5
      },
    • "parameter_values": [
      • {
        }
      ]
    },
  • "reject_management": {
    • "destination": "medium_1",
    • "subfolder": "SUBFOLDER_1",
    • "file_options": {
      • "encoding": "X_MAC_CE",
      • "delimiter": ";",
      • "use_text_quotes": true,
      • "first_line_has_column_names": true,
      • "max_file_size": 100,
      • "line_break": "Windows",
      • "check_md5": false,
      • "max_column_count": 10
      },
    • "create_when_no_records_rejected": false
    },
  • "options": {
    • "file_filter": "*.dat",
    • "trigger_file": "trg",
    • "allow_multiple_imports": false,
    • "fail_if_no_file": false,
    • "fail_if_empty_file": false,
    • "delete_after_processing": false,
    • "process_files_one_by_one": false,
    • "invalid_data_handling": "Stop"
    },
  • "unzip_and_decrypt": {
    • "mode": "Unzip",
    • "unzip_filter": "*.dat",
    • "pgp_decryption": {
      • "recipient": "sec@meetmarigold.com",
      • "passphrase": "encryptionpassword"
      }
    },
  • "destination": {
    • "table_name": "DATA_IMPORT",
    • "include_user_identified_column": false
    },
  • "subfolder": "exports",
  • "source": "medium_1",
  • "file_type": "Unknown",
  • "file_options": {
    • "encoding": "X_MAC_CE",
    • "delimiter": ";",
    • "use_text_quotes": true,
    • "first_line_has_column_names": true,
    • "max_file_size": 100,
    • "line_break": "Windows",
    • "check_md5": false,
    • "max_column_count": 10
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task task_name created successfully.",
  • "errors": [ ]
}

Create SQL task

Create a new task of type SQL.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
enable_after_creation
boolean
Default: false
Example: enable_after_creation=true

Define if the task should be enabled after its creation.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

The API name for a task.

name
required
string

Name of the task.

description
string

Description about the task.

tags
Array of strings (tags)
Default: []

Labels of the object.

scheduler
integer <int32>
Default: 0

Id of the scheduler to use.

object
Default: null

Configure a schedule for this task. If not specified, this task can only be manually triggered.

start_date
string <date-time>
Default: null

Start date for the schedule. When not specified, the schedule would immediately be active.

end_date
string <date-time>
Default: null

End date of the schedule. When not specified, the schedule will remain active until the end of time.

schedule_type
required
string

interval on which this schedule should run.

required
Array of objects

Configure which execution statuses should result in a notification being sent. At most one entry may be given per type. A notification for type=Failure is mandatory.

Array
type
required
string
Enum: "Unknown" "NoFile" "Error" "Failure" "Complete"

State for which this notification should trigger.

  • NoFile: Failed due to a missing file.
  • Error: Task succeeded with errors.
  • Failure: Task failed.
  • Complete: Task succeeded.
groups
Array of strings

API names of the notification groups that should be informed when this state occurs. Notification groups are configured in the Admin Configuration under Access Management. It is mandatory to list at least one notification group or at least one email.

emails
Array of strings

Email address of recipients that should be informed when this state occurs. It is mandatory to list at least one notification group or at least one email.

include_process_details
boolean
Default: false

provide process details in the notification.

folder
string <int64>

Folder ID. The root folder has ID 0.

trigger_journey_after_execution
string
Default: null

API name of a journey to trigger after this task completes successfully. Leave empty to not trigger any journey.

object

Trigger a custom event after this task completes successfully. Leave empty to not trigger any custom event.

list
required
string

API name of the list.

custom_event
required
string

API name of the custom event on the given list.

required
Array of objects (Task_Sql_Procedure)

list of procedures to run with this task.

Array
id
required
integer <int32>

Choose a unique positive integer as id for this stored procedure. This ID can be referred to from the on_success or on_fail of other stored procedures in this list.

Only one stored procedure may exist where its id isn't referred to from any other stored procedure. That stored procedure will be the first one to be executed.

on_success
integer <int32>

If this stored procedure ran successfully, then run the on_success procedure. This must be

  • the id of another stored procedure,
  • 0 to halt execution and consider this sql task a success or
  • -1 to halt execution and consider this sql task a failure.
on_fail
integer <int32>

If this stored procedure failed, then run the on_fail procedure. This must be

  • the id of another stored procedure,
  • 0 to halt execution and consider this sql task a success or
  • -1 to halt execution and consider this sql task a failure.
sp_name
required
string

A name for the stored procedure. The name should start with the prefix 'ST_' and can contain only alphanumerical characters and _ (underscore).

object (Task_Stored_Procedure_Fail_Constraint)

Define when a stored procedure should be considered to have failed based on its returned value.

Array of objects (Task_Stored_Procedure_Parameter_Value)

Input parameters for the stored procedure.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "task_1",
  • "name": "Task 1",
  • "description": "A very nice task.",
  • "tags": [
    • "addresses",
    • "footer",
    • "email",
    • "holiday"
    ],
  • "scheduler": 1,
  • "schedule": null,
  • "notifications": [
    • {
      • "type": "Complete",
      • "groups": [
        ],
      • "emails": [
        ],
      • "include_process_details": false
      }
    ],
  • "folder": "main/tasks",
  • "trigger_journey_after_execution": "journey_1",
  • "trigger_custom_event_after_execution": {
    • "list": "list_1",
    • "custom_event": "custom_event_1"
    },
  • "procedures": [
    • {
      • "id": 1,
      • "on_success": 2,
      • "on_fail": -1,
      • "sp_name": "ST_1.",
      • "fail_constraint": {
        },
      • "parameter_values": [
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Task task_name created successfully.",
  • "errors": [ ]
}

Organization

All organization endpoints

Get organization

Retrieve the details of this organization set up on your instance of Selligent Marketing Cloud.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
name
string

Name of the organization.

image_reference
string or null

The image reference.

image_type
string or null

The type of image.

Array of objects

These are the languages supported by the organization.

Array
name
string

The name of the language.

code
string

The code of the language.

locale
string

The locale of the language.

Array of objects

These are the audiences of organization.

Array
api_name
string

The apiname of audience.

Array of objects

These are the campaign data sources of organization.

Array
name
string

The name of data source.

default_languages
Array of strings

These are the default languages of organization.

default_maildomain
string

The default maildomain of organization.

sms_endpoint
string

The default sms endpoint of organization.

mms_endpoint
string

The default mms endpoint of organization.

mobile_push_endpoint
string

The default mobile endpoint of organization.

facebook_endpoint
string

The default facebook endpoint of organization.

google_customer_match_endpoint
string

The default google customer match endpoint of organization.

snapchat_endpoint
string

The default snapchat endpoint of organization.

twitter_endpoint
string

The default twitter endpoint of organization.

linkedin_endpoint
string or null

The default Linked In endpoint of organization.

whatsapp_template_endpoint
string or null

The default WhatsApp Template endpoint of organization.

Array of objects

These are the tracker of organization.

Array
name
string

The name of tracker.

Array of objects

These are the connector instances of organization.

Array
name
string

The apiname of connector instance.

Array of objects

These are the mediums of organization.

Array
api_name
string

The apiname of medium.

Array of objects

These are the Tag lists of organization.

Array
api_name
string

The apiname of Tag list.

Response samples

Content type
application/json
{
  • "name": "My First Organization",
  • "image_reference": "ref_1",
  • "image_type": "png",
  • "languages": [
    • {
      • "name": "English",
      • "code": "en",
      • "locale": "en-US"
      },
    • {
      • "name": "French",
      • "code": "fr",
      • "locale": "fr-FR"
      }
    ],
  • "audiences": [
    • {
      • "api_name": "main_user_list"
      }
    ],
  • "campaign_data_sources": [
    • "DataSource list_1",
    • "DataSource list_2"
    ],
  • "default_languages": [
    • "English",
    • "French"
    ],
  • "default_maildomain": "meetmarigold.com",
  • "sms_endpoint": "SMS",
  • "mms_endpoint": "MMS",
  • "mobile_push_endpoint": "Mobile",
  • "facebook_endpoint": "Facebook",
  • "google_customer_match_endpoint": "string",
  • "snapchat_endpoint": "Snapchat",
  • "twitter_endpoint": "Twitter",
  • "linkedin_endpoint": "LinkedIn",
  • "whatsapp_template_endpoint": "WhatsApp",
  • "trackers": [
    • {
      • "name": "Shopping Tracker"
      },
    • {
      • "name": "Basket Tracker"
      }
    ],
  • "connector_instances": [
    • {
      • "name": "Connector Tracker 1"
      },
    • {
      • "name": "Salesforce Connector"
      }
    ],
  • "mediums": [
    • {
      • "api_name": "ftp_medium_1"
      },
    • {
      • "api_name": "url_medium_2"
      }
    ],
  • "taglists": [
    • {
      • "api_name": "Sports_Taglist"
      },
    • {
      • "api_name": "Food_Taglist"
      }
    ]
}

Medium

All medium endpoints

List mediums

List defined medium configurations.

query Parameters
filter
string
Default: null
Enum: "Ftp" "Url" "AmazonS3" "AzureBlob" "GoogleCloud" "Repository" "PredefinedMedium" "SelligentCloud"
Example: filter=AmazonS3

Filter mediums by medium type.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects

Collection of mediums.

Array
type
string (type)
Enum: "Ftp" "Repository" "Url" "AzureBlob" "AmazonS3" "GoogleCloud" "PredefinedMedium" "SelligentCloud"

Type of the medium.

api_name
string (api_name)

API Name of the medium.

Response samples

Content type
application/json
{
  • "mediums": [
    • {
      • "type": "Ftp",
      • "api_name": "medium_ftp"
      },
    • {
      • "type": "Url",
      • "api_name": "medium_url"
      },
    • {
      • "type": "Repository",
      • "api_name": "medium_repository"
      },
    • {
      • "type": "AmazonS3",
      • "api_name": "medium_amazonS3"
      },
    • {
      • "type": "AzureBlob",
      • "api_name": "medium_azureBlob"
      },
    • {
      • "type": "GoogleCloud",
      • "api_name": "medium_googleCloud"
      }
    ]
}

Get medium

Retrieve medium (Ftp/Url/Repository/AmazonS3) details.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

not_accessible_organizations_count
integer <int32> (not_accessible_organizations_count)

Number of organizations associated with the object, That cannot be access via the API.

type
string
Enum: "Ftp" "Repository" "Url" "AzureBlob" "AmazonS3" "GoogleCloud" "PredefinedMedium" "SelligentCloud"

Type of the medium.

subfolder
string

SubFolder to access on the server.

data_exchange_type
string
Enum: "Selligent" "DataOut" "DataIn"

Data exchange type.

Response samples

Content type
application/json
Example
{
  • "api_name": "repository",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "A Repository storage medium.",
  • "not_accessible_organizations_count": 1,
  • "type": "Ftp",
  • "subfolder": "sub_folder_1",
  • "data_exchange_type": "Selligent"
}

Delete medium

Use this endpoint to delete a medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The medium has been deleted successfully"
}

Create AmazonS3 medium

Use this endpoint to create a AmazonS3 medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

subfolder
string
Default: null

SubFolder to access on the server.

object
access_key_id
required
string

Access key id.

secret_access_key
required
string

Secret access key.

region_endpoint_code
required
string

Region endpoint code.

bucket_name
required
string

Bucket name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": null,
  • "subfolder": null,
  • "credentials": {
    • "access_key_id": "12345678901234567890",
    • "secret_access_key": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    • "region_endpoint_code": "eu-central-1",
    • "bucket_name": "my_bucket"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully."
}

Update AmazonS3 medium

Update a AmazonS3 medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

subfolder
string (subfolder)

SubFolder to access on the server.

object
access_key_id
string

Access key id.

secret_access_key
string

Secret access key.

region_endpoint_code
string

Region endpoint code.

bucket_name
string

Bucket name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "An Amazon storage medium.",
  • "subfolder": "sub_folder_1",
  • "credentials": {
    • "access_key_id": "12345678901234567890",
    • "secret_access_key": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    • "region_endpoint_code": "eu-central-1",
    • "bucket_name": "my_bucket"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

Create Azureblob medium

Create an Azureblob medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

subfolder
required
string

SubFolder to access the server.

object
connection_string
required
string

Azure blob connection string.

container_name
required
string

Azure blob container name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": null,
  • "subfolder": "sub_folder_1",
  • "credentials": {
    • "connection_string": "DefaultEndpointsProtocol=https;AccountName=teamstorage;AccountKey=the/account/key;EndpointSuffix=core.windows.net",
    • "container_name": "my_container"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully.",
  • "errors": [ ]
}

Update Azureblob medium

Update an Azureblob medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

subfolder
string

SubFolder to access the server.

object (Credentials_AzureBlob)
connection_string
string

Azure blob connection string.

container_name
string

Azure blob container name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "An Microsoft Azureblob storage medium.",
  • "subfolder": "sub_folder_1",
  • "credentials": {
    • "connection_string": "DefaultEndpointsProtocol=https;AccountName=teamstorage;AccountKey=the/account/key;EndpointSuffix=core.windows.net",
    • "container_name": "my_container"
    }
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

Create FTP medium

Create a FTP medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

ftp_type
required
string
Enum: "Unknown" "Ftps" "FtpsImplicit" "Sftp"

Type of ftp mediums (FTPS / FTPSIMPLICIT / SFTP / UNKNOWN)

server
required
string

Address of the FTP server.

login
required
string

Login for accessing FTP server.

password
required
string

Password associated with the Login to access the FTP server.

subfolder
string
Default: ""

Path of a subfolder on FTP server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": null,
  • "ftp_type": "Ftps",
  • "server": "An Ftp medium.",
  • "login": "Admin",
  • "password": "Password",
  • "subfolder": ""
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully.",
  • "errors": [ ]
}

Update FTP medium

Update a FTP medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

ftp_type
string
Enum: "Unknown" "Ftps" "FtpsImplicit" "Sftp"

Type of ftp mediums (FTPS / FTPSIMPLICIT / SFTP / UNKNOWN)

server
string

Address of the FTP server.

login
string

Login for accessing FTP server.

password
string

Password associated with the Login to access the FTP server.

subfolder
string

Path of a subfolder on FTP server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "A storage medium.",
  • "ftp_type": "Ftps",
  • "server": "An Ftp medium.",
  • "login": "Admin",
  • "password": "Password",
  • "subfolder": "sub_folder_1"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

Create GOOGLECLOUD medium

Create a GOOGLECLOUD medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

subfolder
string
Default: null

SubFolder to access on the server.

object
type
required
string

Credentials type.

project_id
required
string

Google project id.

private_key_id
required
string

Private key id.

private_key
required
string

Private key.

client_email
required
string

Client email.

client_id
required
string

client_id.

auth_uri
required
string

Authorization uri.

token_uri
required
string

Token uri.

auth_provider_x509_cert_url
required
string

Provider X509 certificate url.

client_x509_cert_url
required
string

Client X509 certificate url.

bucket_name
required
string

Bucket name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully.",
  • "errors": [ ]
}

Update GOOGLECLOUD medium

Update a GOOGLECLOUD medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

subfolder
string (subfolder)

SubFolder to access on the server.

object (Credentials_GoogleCloud)
type
string

Credentials type.

project_id
string

Google project id.

private_key_id
string

Private key id.

private_key
string

Private key.

client_email
string

Client email.

client_id
string

client_id.

auth_uri
string

Authorization uri.

token_uri
string

Token uri.

auth_provider_x509_cert_url
string

Provider X509 certificate url.

client_x509_cert_url
string

Client X509 certificate url.

bucket_name
string

Bucket name.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

Create Repository medium

Create a Repository medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

subfolder
string
Default: null

SubFolder to access on the server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": null,
  • "subfolder": null
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully.",
  • "errors": [ ]
}

Update Repository medium

Update a Repository medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

subfolder
string

SubFolder to access on the server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "A Repository storage medium.",
  • "subfolder": "sub_folder_1"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

Create URL medium

Create a URL medium

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string (api_name)

API Name of the medium.

name
required
string

Name of the medium.

organizations
required
Array of strings (organizations)

List of organizations linked to the object.

description
string
Default: null

Description of the medium.

url
required
string

URL for accessing the server.

login
required
string

Login for accessing the server.

password
required
string

Password associated with the Login to access the server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": null,
  • "url": "https://www.testurl.com",
  • "login": "Admin",
  • "password": "Password"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium created successfully.",
  • "errors": [ ]
}

Update URL medium

Update a URL medium.

path Parameters
api_name
required
string
Example: medium_1

API name of the medium.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string (api_name)

API Name of the medium.

name
string

Name of the medium.

organizations
Array of strings (organizations)

List of organizations linked to the object.

description
string

Description of the medium.

url
string

URL for accessing the server.

login
string

Login for accessing the server.

password
string

Password associated with the Login to access the server.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "medium_1",
  • "name": "Medium One",
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "description": "A storage medium.",
  • "url": "https://www.testurl.com",
  • "login": "Admin",
  • "password": "Password"
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Medium updated successfully.",
  • "errors": [ ]
}

List organization mediums

Use this endpoint to get list of all mediums mapped to an organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
filter
string
Default: null
Enum: "Ftp" "Url" "AmazonS3" "AzureBlob" "GoogleCloud" "Repository" "PredefinedMedium" "SelligentCloud"
Example: filter=AmazonS3

Filter mediums by medium type.

search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects

Collection of mediums.

Array
type
string (type)
Enum: "Ftp" "Repository" "Url" "AzureBlob" "AmazonS3" "GoogleCloud" "PredefinedMedium" "SelligentCloud"

Type of the medium.

api_name
string (api_name)

API Name of the medium.

Response samples

Content type
application/json
{
  • "mediums": [
    • {
      • "type": "Ftp",
      • "api_name": "medium_ftp"
      },
    • {
      • "type": "Url",
      • "api_name": "medium_url"
      },
    • {
      • "type": "Repository",
      • "api_name": "medium_repository"
      },
    • {
      • "type": "AmazonS3",
      • "api_name": "medium_amazonS3"
      },
    • {
      • "type": "AzureBlob",
      • "api_name": "medium_azureBlob"
      },
    • {
      • "type": "GoogleCloud",
      • "api_name": "medium_googleCloud"
      }
    ]
}

Tag list

All tag list endpoints

List tag lists

Returns Tag lists filtered on the given criteria.

query Parameters
search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Tag_List_Base)

List of tag lists matching the criteria.

Array
api_name
string

API name of the Tag list.

Response samples

Content type
application/json
{
  • "taglists": [
    • {
      • "api_name": "tag_list_1"
      }
    ]
}

Create tag list

Create a new tag list.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
required
string

API name of the Tag list.

name
required
string

Name of Tag list.

description
string

Description of Tag list.

Array of objects (Tag)

Tags associated with Tag list.

Array
tag
string

Tag value.

description
string

Description of tag. Description can contain only alphanumeric characters, underscore (_), hyphen (-), and space.

organizations
Array of strings (organizations)

List of organizations linked to the object.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "tag_list_1",
  • "name": "Tag List 1",
  • "description": "My first tag list",
  • "tags": [
    • {
      • "tag": "TAG1",
      • "description": "a_great_first_tag"
      },
    • {
      • "tag": "TAG2",
      • "description": "a_great_second_tag"
      }
    ],
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Tag list created successfully.",
  • "errors": [ ]
}

Get tag list

Use this endpoint to get details of Tag list with given API name.

path Parameters
api_name
required
string
Example: taglist_1

API name of the Tag list.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
api_name
string

API name of the Tag list.

name
string

Name of Tag list.

description
string

Description of Tag list.

Array of objects (Tag)

Tags associated with Tag list.

Array
tag
string

Tag value.

description
string

Description of tag. Description can contain only alphanumeric characters, underscore (_), hyphen (-), and space.

organizations
Array of strings (organizations)

List of organizations linked to the object.

not_accessible_organizations_count
integer <int32> (not_accessible_organizations_count)

Number of organizations associated with the object, That cannot be access via the API.

lists
Array of strings

Represents api names of lists that the Tag list is associated to.

Response samples

Content type
application/json
{
  • "api_name": "tag_list_1",
  • "name": "Tag List 1",
  • "description": "My first tag list",
  • "tags": [
    • {
      • "tag": "TAG1",
      • "description": "a_great_first_tag"
      },
    • {
      • "tag": "TAG2",
      • "description": "a_great_second_tag"
      }
    ],
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ],
  • "not_accessible_organizations_count": 1,
  • "lists": [
    • "list_1",
    • "list_2"
    ]
}

Update tag list

Update an existing Tag list.

path Parameters
api_name
required
string
Example: taglist_1

API name of the Tag list.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
api_name
string

API name of the Tag list.

name
string

Name of Tag list.

description
string

Description of Tag list.

Array of objects (Tag)

Tags associated with Tag list. (While updating the tag 1. If tags are not specified then existing tags would be retained. 2. If tags are specified as an empty array then all existing tags would be deleted. 3. If tags are specified then those would be added/updated.)

Array
tag
string

Tag value.

description
string

Description of tag. Description can contain only alphanumeric characters, underscore (_), hyphen (-), and space.

organizations
Array of strings

List of organizations linked to the object. (While updating Organizations 1. If Oraganizations are not provided or provided as null, it remains unchanged. 2. If Organizations are provided as empty array, Tag list will be unlinked from all organizations.)

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Request samples

Content type
application/json
{
  • "api_name": "tag_list_1",
  • "name": "Tag List 1",
  • "description": "My first tag list",
  • "tags": [
    • {
      • "tag": "TAG1",
      • "description": "a_great_first_tag"
      },
    • {
      • "tag": "TAG2",
      • "description": "a_great_second_tag"
      }
    ],
  • "organizations": [
    • "Organization_1",
    • "Organization_2"
    ]
}

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "Tag list updated successfully.",
  • "errors": [ ]
}

Delete tag list

Delete an existing Tag list.

path Parameters
api_name
required
string
Example: taglist_1

API name of the Tag list.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

message
string or null (message)

Human readable information.

Array of objects (Errors)

List of errors.

Array
error_code
string

Specific error code.

description
string

A better description of the error.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "message": "The Tag list has been deleted successfully.",
  • "errors": [ ]
}

List Organization tag lists

List Tag lists associated to an organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
search
string
Default: null
Example: search=marigold_1

Search with a specific name, api_name, description or tag(s).

skip
integer <int32>
Default: 0
Example: skip=100

The index to start from, skipping all the previous results.

take
integer <int32>
Default: 0
Example: take=50

The maximum amount of items to return.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
Array of objects (Tag_List_Base)

List of tag lists matching the criteria within the organization.

Array
api_name
string

API name of the Tag list.

Response samples

Content type
application/json
{
  • "taglists": [
    • {
      • "api_name": "tag_list_1"
      }
    ]
}

Folder

All folder endpoints

Create folder

Use this endpoint to create a folder.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Request Body schema: application/json
name
required
string

The name of the folder.

parent_folder_id
integer <int64>
Default: 0

ID of the parent folder, under which we will create this folder. 0 stands for the root folder.

Responses

Response Schema: application/json
object (Folder)
id
integer <int64>

The id of the created folder. Folder id 0 is the root folder.

name
string

The name of the folder.

Request samples

Content type
application/json
{
  • "name": "folder_1",
  • "parent_folder_id": 1
}

Response samples

Content type
application/json
{
  • "folder": {
    • "id": 1,
    • "name": "folder_1"
    }
}

Get folder tree

Use this endpoint to retrieve the contents of a folder on the given organization.

path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

id
required
integer <int64>
Example: 1

ID of the folder. ID 0 is the root folder.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
id
integer <int64>

The id of the created folder. Folder id 0 is the root folder.

name
string

The name of the folder.

result_code
string (result_code)
Enum: "Failed" "Succeeded" "PartiallySucceeded" "ValidationFailed" "NotFound" "ServiceUnavailable" "InternalServerError" "ProtocolError" "RequestEntityTooLarge" "Conflict"

Resulting code for this request.

Array of any

List of assets in this folder. This can be Content assets, Journey assets, list assets, other folders etc.

Array
name
string

Name of the item.

type
string

SubType of the asset:

  • TMP - Content templates (pages, emails, mobile)
  • EXEC - Journeys
  • LIST - Lists
  • SEGMENT - Segment
  • TASK - Task
  • FOLDER - General folder
  • SEGMENTFOLDER - Folder in the Segments folder structure
  • CONTENTBLOCK - Content block
  • LABEL - Asset Label
  • IMPORT - Import task
  • EXPORT - Export task
  • CRMDATASYNC - CRM data sync task
  • CUSTOMCOMPONENTS - Custom component or channel
  • INBOUND - Inbound event
  • CUSTOMEVENT - Custom event
  • CADENCE - Cadence plan
id
integer

Id of the Folder.

Response samples

Content type
application/json
{
  • "result_code": "Succeeded",
  • "id": 100,
  • "name": "TestFolder",
  • "children": [
    • {
      • "id": 10,
      • "name": "folder_1",
      • "type": "FOLDER"
      },
    • {
      • "name": "TestTemplate",
      • "api_name": "TestTemplate",
      • "type": "TMP",
      • "leaf_type": "Template"
      },
    • {
      • "name": "TestEmail",
      • "api_name": "TestEmail",
      • "type": "TMP",
      • "leaf_type": "Email"
      },
    • {
      • "name": "TestMobilePush",
      • "api_name": "TestMobilePush",
      • "type": "TMP",
      • "leaf_type": "MobilePush"
      },
    • {
      • "name": "TestPage",
      • "api_name": "TestPage",
      • "type": "TMP",
      • "leaf_type": "Page"
      },
    • {
      • "name": "TestDataSync",
      • "api_name": "TestDataSync",
      • "type": "CRMDATASYNC",
      • "leaf_type": "CRMDataSync"
      },
    • {
      • "name": "TestImport",
      • "api_name": "TestImport",
      • "type": "IMPORT",
      • "leaf_type": "ImportConfig"
      },
    • {
      • "name": "TestTask",
      • "api_name": "TestTask",
      • "type": "TASK",
      • "leaf_type": "Sql"
      },
    • {
      • "name": "TestCustomComponent",
      • "api_name": "TestCustomComponent",
      • "type": "CUSTOMCOMPONENTS",
      • "leaf_type": "CustomComponent"
      },
    • {
      • "name": "TestList",
      • "api_name": "TestList",
      • "type": "LIST",
      • "leaf_type": "Articlelist"
      },
    • {
      • "name": "TestContentBlock",
      • "api_name": "TestContentBlock",
      • "type": "CONTENTBLOCK",
      • "leaf_type": "ContentBlock"
      },
    • {
      • "name": "TestSingleBatchJourney",
      • "api_name": "TestSingleBatchJourney",
      • "type": "EXEC",
      • "leaf_type": "SingleBatch"
      }
    ]
}

Status

All status endpoints

Get API status

This endpoint will only return an http-status-code. If this is 200 the API is up and running.

header Parameters
X-ApiKey
required
string
Default: {{apiKey}}:{{apiKeySecret}}
Example: {{apiKey}}:{{apiKeySecret}}

API key to authorize requests.

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }