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.

ApiKeyAuth

{{apiKey}}:{{apiSecret}}. These values can be found in your Engage admin section.

Security Scheme Type: API Key
Header parameter name: X-ApiKey

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.

Authorizations:
ApiKeyAuth
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.

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

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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 RCS

Create a single language RCS.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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 (Rcs_Content-2)
object (Rcs_My_Language_Code_Content-2)
text
required
string

Text content of MMS.

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!"
      }
    }
}

Response samples

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

Create SMS

Create a single language SMS.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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

langauges for this message. Note that for messages only one language can be provided at this time.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

query Parameters
search
string
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.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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
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.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

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.

Authorizations:
ApiKeyAuth
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.

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.

Authorizations:
ApiKeyAuth
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.

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).

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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).

Authorizations:
ApiKeyAuth
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.

Request Body schema: application/json
required
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.

Authorizations:
ApiKeyAuth
path Parameters
organization
required
string
Example: marigold_1

Name of the organization to work in.

Request Body schema: application/json
required
ids
Array of strings <uuid> [ items <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> [ items <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.

Authorizations:
ApiKeyAuth
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.

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

Authorizations:
ApiKeyAuth
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.

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