Skip to main content
Skip table of contents

Public Emarsys API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the internal_ prefix in their names. Public API procedures do not have such prefix in their names.

All possible fields with their Ids were included, that you could manipulate with in SQL code in Data Virtuality Studio SQL editor.

 

Administrators

Access to the administrator endpoints is restricted. If you need access, please contact Emarsys Support.

createAdministratorAccount

New administrator account
Parameter
<in_username> (required): The user name of the administrator
<in_password> (required): The password name of the administrator
<in_email> (required): The email address of the administrator
<in_access_level> (required): The identifier of the administrator role
<in_interface_language> (required): The ISO code of the current language used in the Emarsys application
<in_first_name> (optional): The first name of the administrator
<in_last_name> (optional): The last name of the administrator
<in_position> (optional): The role or position of the administrator
<in_pwd_update_interval> (optional): The password expiration date in days
<in_default_upages_lang> (optional): The default language of the www.emarsys.net/u/… links of the launched email campaigns
<in_tz> (optional): The time zone where the administrator is located
<in_mobile_phone> (optional): The mobile phone of the administrator
<in_last_verification_action_date> (optional): Last verification action date
<in_actual_login> (optional): The date of the last login
<in_disabled> (optional): The status of the account
<in_superadmin> (optional): The access level of the administrator

Attribute

Type

Description

id

integer

The identifier of the administrator

username

string

The user name of the administrator

email

string

The email address of the administrator

first_name

string

The first name of the administrator

last_name

string

The last name of the administrator

interface_language

string

The ISO code of the current language used in the Emarsys application

default_upages_lang

string

The default language of the www.emarsys.net/u/… links of the launched email campaigns

access_level

integer

The identifier of the administrator role

position

string

The role or position of the administrator

title

string

The title of the administrator

tz

string

The time zone where the administrator is located

mobile_phone

string

The mobile phone of the administrator

pwd_update_interval

integer

The password expiration date in days

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

getInterfaceLanguages

Available user interface languages
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

lang_code

string

Language code

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_examples"."example_getInterfaceLanguages" as select
        *
    from
        ( call "emarsys_examples.getInterfaceLanguages" ( ) ) f
;;


getAccessLevels

Available access levels for the customer's account
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer


name

string


reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_getAccessLevels" as select
        *
    from
        ( call "emarsys_connector.getAccessLevels" ( ) ) f
;;

getAdministratorsList

Admininstrator users
Parameter
<admin_id> (optional): The identifier of the administrator
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The identifier of the administrator

username

string

The user name of the administrator

email

string

The email address of the administrator

first_name

string

The first name of the administrator

last_name

string

The last name of the administrator

interface_language

string

The ISO code of the current language used in the Emarsys application

default_upages_lang

string

The default language of the www.emarsys.net/u/… links of the launched email campaigns

access_level

integer

The identifier of the administrator role

position

string

The role or position of the administrator

title

string

The title of the administrator

tz

string

The time zone where the administrator is located

mobile_phone

string

The mobile phone of the administrator

superadmin

integer

The access level of the administrator

disabled

integer

The status of the account

last_verification_action_date

timestamp

Last verification action date

actual_login

timestamp

The status of the account

pwd_update_interval

integer

The password expiration date in days

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_getAdministratorsList" as select
        *
    from
        ( call "emarsys_connector.getAdministratorsList" ( ) ) f
;;

getLanguages

Available languages for creating emails
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id_lang

string

The language identifier

lang

string

The name of the language

updateAdministratorAccount

Update administrator account
Parameter
<in_admin_id> (required): The identifier of the administrator
<in_username> (optional): The user name of the administrator
<in_password> (optional): Password
<in_email> (optional): The email address of the administrator
<in_access_level> (optional): The identifier of the administrator role
<in_interface_language> (optional): The ISO code of the current language used in the Emarsys application
<in_first_name> (optional): The first name of the administrator
<in_last_name> (optional): The last name of the administrator
<in_position> (optional): The role or position of the administrator
<in_pwd_update_interval> (optional): The password expiration date in days
<in_default_upages_lang> (optional): The default language of the www.emarsys.net/u/… links of the launched email campaigns
<in_tz> (optional): The time zone where the administrator is located
<in_mobile_phone> (optional): The mobile phone of the administrator
<in_last_verification_action_date> (optional): Last verification action date
<in_actual_login> (optional): The status of the account
<in_disabled> (optional): The status of the account
<in_superadmin> (optional): The access level of the administrator

Attribute

Type

Description

id

integer

The identifier of the administrator

username

string

The user name of the administrator

email

string

The email address of the administrator

first_name

string

The first name of the administrator

last_name

string

The last name of the administrator

interface_language

string

The ISO code of the current language used in the Emarsys application

default_upages_lang

string

The default language of the www.emarsys.net/u/… links of the launched email campaigns

access_level

integer

The identifier of the administrator role

position

string

The role or position of the administrator

title

string

The title of the administrator

tz

string

The time zone where the administrator is located

mobile_phone

string

The mobile phone of the administrator

pwd_update_interval

integer

The password expiration date in days

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

deleteAdministratorAccount

Delete administrator account
Parameter
<in_admin_id> (required): The identifier of the administrator
<in_successor_administrator_id> (required): The identifier of the successor administrator

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

getAvailableFieldChoices

All available options for any given single- or multi-choice field
Parameter
<in_field_id> (required): The field identifier
<in_lang> (optional): The two-letter ISO 639-1 language code

Attribute

Type

Description

id

integer

Admininstrator users

choice

string

Admininstrator users

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

example
SQL
create view "emarsys_examples"."example_getAvailableFieldChoices" as select
        *
    from
        ( call "emarsys.getAvailableFieldChoices" ( in_field_id => '6', in_lang => 'fr' ) ) f;;

Exports

exportDataDownload

Returns a CSV file once the export job is finished
Parameter
<in_Export_ID> (required): The identifier of the export job initiated at the Export Updated Contacts endpoint

Attribute

Type

Description

response

blob


SQL
create view "emarsys_connector_example"."example_ExportDataDownload" as select
        to_chars ( gg.response, 'UTF-8' ) as blobconverted
    from
        ( call "emarsys_connector.ExportDataDownload" ( "in_Export_ID" => 118559 ) ) gg

Exporting Changes

Export procedures include a sequence of api executed step by step to make the result returned as usual dataset.

Depending on the requested columns final dataset differs. 

To get the export_changes content you have to execute 2 procedures sequentially:

  1. exportChanges_pre()
  2. export_changes()

exportChanges_pre


As a result export_changes() procedure will be created, which includes all the fields except: 27 – avg. length of visit; 28 – avg. pages per day; 29 – last mail received; 32 – user status; 33 – contact source. Field's list is obtained by execution of getFields ( ).

Creates procedure Export_Changes
Parameter
<in2_lang> (optional): The language of the export

Attribute

Type

Description

state

boolean

State

export_changes

Exports all the fields of all contacts which have been updated within a specified time period.
SQL
export_changes(string <in_start_date>, string <in_end_date>, string <in_lang>)

Parameters:

<in_start_date> (optional) - start date of a time range for request. The following date format is accepted here: YYYY-MM-DD. Please note that start date and end date must be different to have exported data. If value is not set day before current date is used.

<in_end_date> (optional) - end date of a time range for the request. The following date format is accepted here: YYYY-MM-DD. Please note that start date and end date must be different to have exported data. If value is not set current date is used.

<in_lang> (optional) - language, what is obtained by execution getLanguages ( ) . If nothing is set, default value is en.

SQL
CREATE VIEW "emarsys_connector_example"."example_export_changes" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.export_changes" ( "in_lang" => 'en' ) ) pp

Export Contact List

Export procedures include a sequence of api executed step by step to make the result returned as usual dataset.

Depending on the requested columns final dataset differs.  

To obtain export_changes content it's mandatory to execute 2 procedures sequentially:

  1. exportContactList_pre()
  2. export_contactlist()

exportContactList_pre

As a result export_contactlist() procedure will be created, which includes all the fields except: 27 – avg. length of visit; 28 – avg. pages per day; 29 – last mail received; 32 – user status; 33 – contact source. Field list is obtained by execution of getFields().

Creates procedure Export_ContactList
Parameter
<in2_lang> (optional): The language of the export

Attribute

Type

Description

state

boolean

State

export_contactlist

Exports all fields of contacts from a specified contact list.
export_contactlist(integer <contactlist_ID>, string <in_lang>)

Parameters:

<contactlist_ID> (required) - ID of a contact list to export the fields of the contacts from. It could be obtained by execution of getContactlists_names ().

<in_lang> (optional) - language from execution of getLanguages(). If nothing is set, default value is en.

SQL
CREATE VIEW "emarsys_connector_example"."example_export_contactlist" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.export_contactlist" ( "contactlist_ID" => 381180208, "in_lang" => 'en' ) ) pp

Export Contact Regs

Export procedures include a sequence of api executed step by step to make the result returned as usual dataset.

Depending on the requested columns final dataset differs.  

To obtain export_changes content it's mandatory to execute 2 procedures sequentially:

  1. exportContactRegs_pre()
  2. export_contact_regs()

exportContactRegs_pre

As a result export_contact_regs() procedure  will be created, which includes all the fields except: 27 – avg. length of visit; 28 – avg. pages per day; 29 – last mail received; 32 – user status; 33 – contact source. Field list is obtained by execution of getFields().

Creates procedure Export_Contact_Regs
Parameter
<in2_lang> (optional): The language of the export

Attribute

Type

Description

state

boolean

State

export_contact_regs

Exports all the fields of all contacts according to the _timerange parameter (e.g. all contacts registered between X and Y)
SQL
export_contact_regs(string <in_start_date>, string <in_end_date>, string <in_lang>)

Parameters: 

<in_start_date> (optional) - start date of a time range for request. The following date formats is accepted here: YYYY-MM-DD HH:mm:SS, YYYY-MM-DD HH:mm, YYYY-MM-DD. Please note that start date and end date must be different to have exported data. If value is not set day before current date is used.

<in_end_date> (optional) - end date of a time range for request. The following date format is accepted here: YYYY-MM-DD HH:mm:SS, YYYY-MM-DD HH:mm, YYYY-MM-DD. Please note that start date and end date must be different to have exported data. If value is not set current date is used.

<in_lang> (optional) - language from execution of getLanguages(). If nothing is set, default value is en.

Export_Responses

Export procedures include a sequence of api executed step by step to make the result returned as usual dataset.

Depending on the requested columns final dataset differs. 

To obtain export_changes content it's mandatory to execute 2 procedures sequentially:

  1. exportResponses_pre()
  2. Export_Responses()

exportResponses_pre


As a result Export_responses() procedure will be created, which includes all the fields except: 27 – avg. length of visit; 28 – avg. pages per day; 29 – last mail received; 32 – user status; 33 – contact source. Field's list is obtained by execution of getFields().

Creates procedure export_Responses
Parameter
<in2_lang> (required): The language of the export
<in2_analysis_fields_responses> (required): The contact behaviors to analyse based on specific field types of the email campaign
<in2_contacts_fields_responses> (required): The field identifiers to include in the export

Attribute

Type

Description

state

boolean

State


SQL
create view "emarsys_connector_example"."example_exportResponses_pre" as select
f.state
from
( call "emarsys_connector.exportResponses_pre"(
"in2_lang" => 'en',
"in2_analysis_fields_responses" => '"5", "8", "15"',
"in2_contacts_fields_responses" => '"1", "3", "5"'
)) f

export_responses

Exports the selected fields of all contacts who responded to emails within the specified time range.
SQL
export_responses(string <in_start_date>, string <in_end_date>, string <in_lang>)

Parameters:

<in_start_date> (optional) - start date of a time range for request. The following date formats is accepted here: YYYY-MM-DD HH:mm:SS, YYYY-MM-DD HH:mm, YYYY-MM-DD. If value is not set the day before current date is used.

<in_end_date> (optional) - end date of a time range for request. The following date format is accepted here: YYYY-MM-DD HH:mm:SS, YYYY-MM-DD HH:mm, YYYY-MM-DD.  If value is not set the day before current date is used.

<in_lang> (optional) - language from execution of getLanguages(). If nothing is set, default value is en.

SQL
CREATE VIEW "emarsys_connector_example"."example_export_responses" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.export_responses" ( "in_lang" => 'en' ) ) ss 

Export_segment

Export procedures include a sequence of api executed step by step to make the result returned as usual dataset.

Depending on the requested columns final dataset differs.

To obtain export_changes content it's mandatory to execute 2 procedures sequentially:

  1. exportSegment_pre()
  2. export_segment()

exportSegment_pre

As a result export_segment() procedure  will be created, which includes all the fields except: 27 – avg. length of visit; 28 – avg. pages per day; 29 – last mail received; 32 – user status; 33 – contact source. Field's list is obtained by execution of getFields().

Creates procedure Export_Changes
Parameter
<in2_lang> (required): The language of the export

Attribute

Type

Description

state

boolean

State


SQL
CREATE VIEW "emarsys_connector_example"."example_exportSegment_pre" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.exportSegment_pre" ( ) ) f

export_segment

Exports the content from all fields from all contacts within a specified segment.
SQL
export_segment(integer <in_filter_id>, string <in_lang>) 

Parameters:

<in_filter_id (required) - segmentID to export the desired field content from contacts of it. Possible values are obtained by execution of getSegmentsList(). 

<in_lang> (optional) - language from execution of getLanguages(). If nothing is set, default value is en.

SQL
CREATE VIEW "emarsys_connector_example"."example_export_segment" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.export_segment" ( "in_filter_id" => 280021, "in_lang" => 'de' ) ) pp

do_query_export_status

Fetches the status data of the export by the ID returned by the export procedures.

SQL
do_query_export_status(integer <Export_ID>)

Parameter:

<Export_ID> (required) - an ID returned by the above export procedures.

SQL
CREATE VIEW "emarsys_connector_example"."example_query_export_status" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.do_query_export_status"(
    "Export_ID" => 27278
)) AS sta

Contact Fields

New field
Parameter
<in_name> (required): The unique name of the new field
<in_application_type> (required): The type of the new field

Attribute

Type

Description

field_id

integer

The identifier of the new field

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_createField" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createField" ( in_name => 'First Name', in_application_type => 'shorttext' ) ) f
;;

getFields

Contact fields
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id_field

integer

The field identifier

name_field

string

The field name

application_type

string

The field type


SQL
CREATE VIEW emarsys_connector_example.example_getFields AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getFields" ()) a

Contact Sources

getSource

Contact sources
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id_source

integer

The identifier of the contact source

name_source

string

The name of the contact source


SQL
CREATE VIEW emarsys_connector_example.example_getSource AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getSource" ()) a;;

createSource

New source
Parameter
<in_name> (required): The source name

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_createSource" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createSource" ( in_name => 'source name' ) ) f
;;

deleteFile

Delete file
Parameter
<in_file_id> (required): The identifier of the field

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_deleteSource" as select
 *
 from
 ( call "emarsys_connector.deleteSource" ( in_source_id => 1234567 ) ) f
;;

deleteSource

Deletes an existing contact source.


SQL
deleteSource(integer <in_source_id>)

Parameters:

<in_source_id> (required) - ID of the contact source to be deleted.


SQL
CREATE VIEW "emarsys_connector_example"."example_deleteSource" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteSource" ( in_source_id => 1234567 ) ) f
;;

Segments

checkSegmentContact

Is contact in segment
Parameter
<in_segment_id> (required): Segment Id
<in_contact_id> (required): Contact Id

Attribute

Type

Description

is_insegment

boolean

Is contact in segment

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_checkSegmentContact" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.checkSegmentContact" ( in_segment_id => 199084, in_contact_id => 984966565 ) ) f
;;

createCombinedSegment

Deprecated
Parameter
<in_name> (required):
<in_include_relation> (required):
<in_include_segment_ids> (required):
<in_exclude_relation> (required):
<in_exclude_segment_ids> (required):
<in_combined_segment_id> (optional):

Attribute

Type

Description

id

integer


name

string


definition

string


relation

string


segment_id

integer


reply_code

integer


reply_text

string


SQL
CREATE VIEW "emarsys_connector_example"."example_createCombinedSegment" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createCombinedSegment" ( in_name => 'combined_6', in_include_relation => 'OR', in_include_segment_ids => '100011869' , in_exclude_relation => 'OR',in_exclude_segment_ids => '100017571, 100017572'  ) ) f         
;;

updateCombinedSegment

Deprecated
Parameter
<in_name> (required):
<in_include_relation> (required):
<in_include_segment_ids> (required):
<in_exclude_relation> (required):
<in_exclude_segment_ids> (required):
<in_combined_segment_id> (required):

Attribute

Type

Description

id

integer


name

string


definition

string


relation

string


segment_id

integer


reply_code

integer


reply_text

string


SQL
CREATE VIEW "emarsys_connector_example"."example_updateCombinedSegment" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.updateCombinedSegment" ( in_name => 'combined_6', in_include_relation => 'OR', in_include_segment_ids => '100011869' , in_exclude_relation => 'OR',in_exclude_segment_ids => '100017571, 100017572'  ) ) f         
;;

updateSegmentContactCriteria

Update segment contact criteria
Parameter
<in_segment_id> (required): The segment identifier
<in_contact_criteria> (required): Contact criteria

Attribute

Type

Description

contact_criteria

string

Contact criteria

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
create view "emarsys_examples"."example_w_updateSegmentContactCriteria" as select
        *
    from
        ( call "emarsys.updateSegmentContactCriteria" ( in_segment_id => 1234567, in_contact_criteria => '{ "type": "and", "children": [{ "type": "criteria", "field": "gender", "operator": "equals", "value": "female" }, { "type": "criteria", "field": "age", "operator": "greater_or_equal", "value": "22" }]}' ) ) f;;

getCombinedSegment

Deprecated
Parameter
<in_combined_segment_id> (required):

Attribute

Type

Description

id

integer


name

string


definition

string


relation

string


segment_id

integer


reply_code

integer


reply_text

string


SQL
create view "emarsys_examples"."example_getCombinedSegment" as select
        *
    from
        ( call "emarsys.getCombinedSegment" ( in_combined_segment_id => 123123123 ) ) f;;

getCombinedSegmentsList

Deprecated
Parameter

Attribute

Type

Description

id

integer


name

string


reply_code

integer


reply_text

string


SQL
CREATE VIEW "emarsys_connector_example"."example_getCombinedSegmentsList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getCombinedSegmentsList" ( ) ) f
;;

 

Conditions

getConditions

Conditional text rules
Parameter

Attribute

Type

Description

id

integer

The identifier of the conditional text rule

name

string

The name of the conditional text rule

condName

string

The a placeholder to use in the HTML or plain text source of emails

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getConditions" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getConditions" ( ) ) f
;;

Contacts


createContact

New contacts
Parameter
<in_source_table> (required): The name of the table with contact data
<in_key_id> (optional): Identifies the contact by their id

Attribute

Type

Description

id

integer

The contact identifier

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

SQL
create view "emarsys_connector_example"."example_createContact" as select
*
from
( call "emarsys_connector.createContact" ( in_source_table => 'emarsys_connector.contacts' ) ) f
;;

  

createMultipleContacts

New contacts
Parameter
<in_source_table> (required): The name of the table with contact data
<in_key_id> (optional): Identifies the contact by their

Attribute

Type

Description

id

integer

The contact identifier

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

SQL
CREATE VIEW "emarsys_connector_example"."example_createMultipleContacts" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createMultipleContacts" ( in_source_table => 'emarsys_connector.contacts' ) ) f
;;
 

getContacts_emails

The internal identifier of a contact by the specified field and its value
Parameter
<in_limit> (optional): Specifies the maximum number of records to return
<in_excludeempty> (optional): If true, contacts with a null or empty value in the specified field are not returned

Attribute

Type

Description

id_contact

integer

The numeric contact identifier

e_mail_contact

string

E-mail

SQL
CREATE VIEW emarsys_connector_example.example_getContacts_emails AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getContacts_emails" (
                "in_limit" => null
                ,"in_excludeempty" => null
            )
        )a

getContactCriteria

The contact criteria for the specified segment
Parameter
<in_segment_id> (required): The segment identifier

Attribute

Type

Description

type

string

Defines the function of each node

child_type

string

The grouping operator that defines the relationship between filter nodes

child_field

string

The field name used as criterion

child_operator

string

The logical operator for comparing the specified field and its value

child_value

string

The value of the specified field

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getContactCriteria" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getContactCriteria" ( in_segment_id => 199084 ) ) f
;;

getContactInternalID

The internal identifier of a contact by the specified field and its value
Parameter
<in_key_field_id> (required): The identifier of the key field to use
<in_key_field_value> (required): The value of the key field to identify the contact

Attribute

Type

Description

id

integer

The numeric contact identifier

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getContactInternalID" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getContactInternalID" ( in_key_field_id => '3', in_key_field_value => 'user@example.com' ) ) f
;;


getContactEmailHistory

Contact email history
Parameter
<in_contacts> (required): An array of contact identifiers that specifies the contacts to return
<in_start_date> (optional): Filters emails from the specified date
<in_end_date> (optional): Filters emails by the specified date

Attribute

Type

Description

email_id

integer

The numeric campaign identifier

contact_id

integer

The numeric contact identifier

launch_date

timestamp

The launch date of the campaign

delivery_status

string

The status of the campaign

bounce_status

string

The deliverability status

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getContactEmailHistory" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getContactEmailHistory" ( in_contacts => '176415518, 749678081', in_start_date => '2014-11-05', in_end_date => '2014-11-05' ) ) f
;;

deleteContact

Delete contact
Parameter
<in_key_id> (optional): Identifies the contact by their id
<in_key_value> (required): The key value

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_deleteContact" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteContact" ( in_key_id => '3', in_key_value => 'user@example.com' ) ) f
;;

updateContact

Update contact
Parameter
<in_source_table> (required): The name of the table with contact data
<in_key_id> (optional): Identifies the contact by their
<in_create_if_not_exists> (optional): Create if not exists

Attribute

Type

Description

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

id

integer

The contact id

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_examples"."example_w_updateContact" as select
*
from
( call "emarsys.updateContact" ( in_source_table => 'emarsys.contacts' ) ) f;;
 

updateMultipleContacts

Update multiple contacts
Parameter
<in_source_table> (required): The name of the table with contact data
<in_key_id> (optional): Identifies the contact by their
<in_create_if_not_exists> (optional): Create if not exists

Attribute

Type

Description

id

integer

The contact id

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

SQL
create view "emarsys_examples"."example_w_updateMultipleContacts" as select
*
from
( call "emarsys.updateMultipleContacts" ( in_source_table => 'emarsys.contacts' ) ) f;;

Contact Lists

checkContactlistContact

Is contact in contact list
Parameter
<in_list_id> (required): Contact List Id
<in_contact_id> (required): Contact Id

Attribute

Type

Description

is_inlist

boolean

Is contact in list

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_checkContactlistContact" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.checkContactlistContact" ( in_list_id => 381180208, in_contact_id => 381002129 ) ) f
;;

getContactlistContacts

A list of contact identifiers from the contact list
Parameter
<list_id> (optional): The contact list identifier
<list_id_table> (optional): The table name with contact list identifier data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

list_id

integer

The contact list identifier

id

integer

The contact identifier

SQL
create view "emarsys_examples"."example_getContactlistContacts" as select
        *
    from
        ( call "emarsys.getContactlistContacts" ( in_list_id => 217410714 ) ) f;;

getContactlists_names

Contact lists
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

Contact list identifier

name

string

Contact list name

created

timestamp

Created date

type

string

Type

SQL
CREATE VIEW emarsys_connector_example.example_getContactlists_names AS SELECT
        *
    FROM
        ( CALL emarsys_connector.getContactlists_names ( ) ) a
;;

createContactList

New contact list
Parameter
<in_source_table> (required): The name of the source table with contact identifiers
<in_name> (required): Identifies the contact by their name
<in_description> (optional): Description
<in_key_id> (optional): Identifies the contact by their id

Attribute

Type

Description

id

integer

The contact list identifier

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

SQL
CREATE VIEW "emarsys_connector_example"."example_createContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createContactList" ( in_source_table => 'source_table', in_name => 'new name' ) ) f
;;

addContactsToContactList

Adds new contacts to an existing contact list

Parameter
<in_source_table> (required): The name of the source table with contact identifiers
<in_list_id> (optional): The contact list identifier
<in_key_id> (optional): Identifies the contact by their id

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

inserted_contacts

integer

The number of contacts successfully added to the list

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason


SQL
CREATE VIEW "emarsys_connector_example"."example_addContactsToContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.addContactsToContactList" ( in_source_table => 'source_table', in_list_id => 381180208 ) ) f
;;

checkContactInternalID

List of existing contacts and errors indexed by the specified key identifier
Parameter
<in_source_table> (required):
<in_key_id> (optional):

Attribute

Type

Description

id

integer

Contact Id

key_value

string

Contact key field value

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason

deleteContactsFromContactList

Delete contacts from contact list
Parameter
<in_source_table> (required): The name of the source table with contact identifiers
<in_list_id> (required): Contact List identifier
<in_key_id> (optional): Identifies the contact by their id

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

deleted_contacts

integer

Deleted contacts

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason


SQL
CREATE VIEW "emarsys_connector_example"."example_deleteContactsFromContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteContactsFromContactList" ( in_source_table => 'source_table', in_list_id => 381180208 ) ) f
;;

renameContactList

Rename contact list
Parameter
<in_list_id> (required): The contact list identifier
<in_name> (required): The new unique name of the contact list

Attribute

Type

Description

id

integer

The contact list identifier

name

string

The new name of the contact list

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_renameContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.renameContactList" ( in_list_id => 381180208, in_name => 'new name' ) ) f
;;

replaceContactList

Replace contact list
Parameter
<in_source_table> (required): The name of the source table with contact identifiers
<in_list_id> (required): List of contact identifiers to be included
<in_key_id> (optional): Identifies the contact by their id

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

inserted_contacts

integer

The Emarsys response code

err_key_value

string

The error key value

err_reply_code

integer

The error code

err_reply_text

string

The error reason


SQL
CREATE VIEW "emarsys_connector_example"."example_replaceContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.replaceContactList" ( in_source_table => 'source_table', in_list_id => 381180208 ) ) f
;;

deleteContactList

Delete contact list
Parameter
<in_list_id> (required): Identifies the contact list

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_deleteContactList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteContactList" ( in_list_id => 381180208 ) ) f
;;

Customers


getCustomerFormsList

Customer forms
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The form identifier

name

string

The form name

type

string

The form type

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getCustomerFormsList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getCustomerFormsList" ( ) ) f
;;
 

getCustomerSettings

Customer settings
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

environment

string

The URI of the environment the customer account belongs to

timezone

string

The timezone of the customer account

name

string

The name of the customer account

password_history_queue_size

integer

The number of the previous passwords that are no longer allowed to be used

country

string

Country

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getCustomerSettings" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getCustomerSettings" ( ) ) f
;;

Email Campaigns


createEmailCampaign

New email campaign
Parameter
<in_language> (required): The language of the email campaign
<in_name> (required): The title of the email
<in_fromemail> (required): The email address of the sender
<in_fromname> (required): The name of the sender
<in_subject> (required): The subject of the email
<in_email_category> (required): The category identifier that the email is assigned to
<in_html_source> (required): The HTML body of the email
<in_text_source> (required): The plain text source of the email
<in_external_event_id> (optional): The identifier of the external event for the email
<in_filter> (optional): The segment identifier for the email
<in_combined_segment> (optional): The identifier of the combined segment for the email
<in_contactlist> (optional): The identifier of the contact list for the email
<in_template> (optional): The identifier of the template for creating a template-based campaign
<in_unsubscribe> (optional): If provided, the email contains an unsubscribe link
<in_browse> (optional): If provided, the email contains a link to an online version
<in_text_only> (optional): If provided, the email is sent in plain text only
<in_cc_list> (optional): The identifier of the contact list to receive a copy of the email
<in_additional_linktracking_parameters> (optional): Creates additional URL parameters that are added to the tracked links URL on redirect
<in_exclude_segment_id> (optional): Excludes the specified segment from the recipient list
<in_exclude_contact_list_id> (optional): Excludes the specified contact list from the recipient list

Attribute

Type

Description

id

integer

The identifier of the email campaign

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_createEmailCampaign" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.createEmailCampaign" ( in_name => 'test_camp_6', in_language => 'en', in_fromemail => 'malekith@example.com', in_fromname => 'Malekith', in_subject => 'convergence', in_email_category => '111111111', in_html_source => 'Hello First Name...', in_text_source => 'Hello First Name...', in_browse => 0, in_text_only => 1, in_unsubscribe => 1, in_filter => '222222222'
        	 ) ) f
;; 


copyEmailCampaign

Makes a copy of an email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_name> (optional): The name of the new email campaign

Attribute

Type

Description

campaign_id

integer

The identifier of the new campign

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_copyEmailCampaign" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.copyEmailCampaign" ( in_email_id => 255244 ) ) f
;;

deleteEmailCampaign

Delete email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_deleteEmailCampaign" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteEmailCampaign" ( in_email_id => 255244 ) ) f
;;

finalizeEmailCampaign

Finalize email campaign

Parameter
<in_email_id> (required): The identifier of the email campaign

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_finalizeEmailCampaign" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.finalizeEmailCampaign" ( in_email_id => 255244 ) ) f
;;

getEmailCampaignCategories

Email campaign categories
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The identifier of the campaign category

category

string

The name of the campaign category

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_examples"."example_getEmailCampaignCategories" as select
        *
    from
        ( call "emarsys_connector.getEmailCampaignCategories" ( ) ) f
;;

getEmailCampaignsList

Email campaigns
Parameter
<email_id> (optional): Email identifier
<status> (optional): Status of the campaign
<launched> (optional): Filters campaigns by their launch status
<contactlist> (optional): Identifier of the contact list
<showdeleted> (optional): Filters deleted campaigns
<fromdate> (optional): Lists campaigns created after the specified date
<todate> (optional): Lists campaigns created before the specified date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

Email identifier

root_email

integer

Root email

language

string

Email language

created

timestamp

Creation date of the email

deleted

timestamp

Deletion date of the email (if applicable)

name

string

Name of the email

status

string

Status of the email

api_status

string

Launch status of the campaign

api_error

string

Any specific error related to the endpoints or methods

fromemail

string

Sender of the email

fromname

string

Name of the email sender

subject

string

Subject line of the email

email_category

string

Category identifier of the email

filter

string

Identifier of the associated segment included from the recipient source

exclude_filter

string

Identifier of the associated segment exclude from the recipient source

contactlist

string

Identifier of the associated contact list included in the recipient source

exclude_contactlist

string

Identifier of the associated contact list excluded in the recipient source

template

string

Identifier of the email template

unsubscribe

string

Unsubscribe

browse

string

Browse

text_only

string

Text_only

cc_list

integer

Identifier of the contact list to receive a copy of the email

source

string

Origin of the recipient

html_source

string

HTML source of the email

text_source

string

Plain text source of the email

fromemail_host

string

Indicates whether Emarsys reply mail management is used (emarsys) or not (external)

content_type

string

The email content type

root_campaign_id

string

The identifier of the root campaign

version_name

string

The name of the root campaign

SQL
create view "emarsys_examples"."example_getEmailCampaignsList" as select
        *
    from
        ( call "emarsys.getEmailCampaignsList" ( showdeleted => 0 ) ) f;;

getLanguages

Returns a list of languages which authenticated customers can use in email creation.

SQL
CREATE VIEW emarsys_connector_example.example_getLanguages AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getLanguages" ()) a
;;

updateEmailCampaign

Update email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_language> (required): The language of the email campaign
<in_name> (required): The title of the email
<in_fromemail> (required): The email address of the sender
<in_fromname> (required): The name of the sender
<in_subject> (required): The subject of the email
<in_html_source> (required): The HTML body of the email
<in_text_source> (required): The plain text source of the email
<in_unsubscribe> (optional): If provided, the email contains an unsubscribe link
<in_browse> (optional): If provided, the email contains a link to an online version
<in_additional_linktracking_parameters> (optional): Creates additional URL parameters that are added to the tracked links URL on redirect

Attribute

Type

Description

id

integer

The email identifier

root_email

integer

Root email

language

string

The language of the email campaign

created

timestamp

The creation date of the email

deleted

timestamp

The deletion date of the email

name

string

The title of the email

status

integer

The status of the email

api_status

integer

The launch status of the campaign

api_error

integer

Any specific error related to the endpoints or methods

fromemail

string

The email address of the sender

fromname

string

The name of the sender

subject

string

The subject of the email

email_category

integer

The category identifier that the email is assigned to

filter

integer

The segment identifier for the email

exclude_filter

integer

The identifier of the associated segment excluded from the recipient source

contactlist

integer

The identifier of the contact list for the email

exclude_contactlist

string

Excludes the specified contact list from the recipient list

template

integer

The identifier of the template for creating a template-based campaign

unsubscribe

string

If provided, the email contains an unsubscribe link

browse

string

If provided, the email contains a link to an online version

text_only

string

If provided, the email is sent in plain text only

cc_list

string

The identifier of the contact list to receive a copy of the email

source

string

The origin of the recipient

html_source

string

The HTML body of the email

text_source

string

The plain text source of the email

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_updateEmailCampaign" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.updateEmailCampaign" ( in_email_id => 255244, in_name => 'test_camp_6', in_language => 'en', in_fromemail => 'malekith@example.com', in_fromname => 'Malekith', in_subject => 'convergence' ) ) f
;; 


updateEmailCampaignRecipientSource

Update email campaign recipient source
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_filter_id> (optional): The identifier of the recipient source segment
<in_contactlist_id> (optional): The identifier of the recipient source contact list

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_updateEmailCampaignRecipientSource" as select
f.*
from
( call "emarsys_connector.updateEmailCampaignRecipientSource" ( in_email_id => 255244, in_filter_id => 0 ) ) f
;;

Events

createExternalEvent

Creates an external event with the specified name in order to allow your external program, such as a CMS or CRM to trigger an Emarsys event
Parameter
<name> (required): The name of the external event

Attribute

Type

Description

id

integer

The identifier of the external event

name

string

The name of the external event

getExternalEvents

External event names and identifiers. Use the returned identifiers to trigger emails or programs
Parameter
<eventId> (optional): The identifier of the external event
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The identifier of the external event

name

string

The name of the external event

created

timestamp

The creation date of the external event

Sections

createEmailSection

New section to a template-based email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_section_id> (optional): The section identifier
<in_order> (optional): Indicates the order of the sections
<in_group_id> (optional): The identifier of the group that contains the section
<in_hide_on_mobile> (optional): Determines whether the section is displayed on mobile
<in_header_source> (optional): The HTML content of the header
<in_header_align> (optional): The alignment of the text in the header
<in_body_source> (optional): The HTML content of the body text
<in_image_url> (optional): The URL of the image
<in_image_title> (optional): The image caption
<in_image_link> (optional): The destination URL of the image when clicked
<in_image_align> (optional): The alignment of the image within the section
<in_image_width> (optional): The width of the image in pixels
<in_image_height> (optional): The height of the image in pixels
<in_image_hide_on_mobile> (optional): Determines whether the image is displayed on mobile
<in_image_mobile> (optional): Either the URL of the image or a generated name if it is in the media database
<in_image_mobile_name> (optional): The original name of the image
<in_link_url> (optional): The link URL
<in_link_title> (optional): The link title
<in_is_image_linked> (optional): Determines whether clicking on the image jumps to the URL defined in the link_url parameter
<in_is_header_linked> (optional): Determines whether clicking on the header jumps to the URL defined in the link_url parameter
<in_link_description> (optional): The description displayed in the individual link tracking analysis under Reporting in the Emarsys application
<in_form_id> (optional): The identifier of the form
<in_form_title> (optional): The title of the form
<in_target_audience> (optional): Determines the recipient group
<in_use_social_network> (optional): Determines whether clickable social network icons are displayed in the section
<in_enable_network_sharing> (optional): Determines whether network sharing is enabled
<in_advanced_html_source> (optional): The advanced HTML source of the section
<in_advanced_text_source> (optional): The advanced plain text source of the section
<in_target_audience_segment_id> (optional): The identifier of the target segment

Attribute

Type

Description

id

integer

Indicates the section

order

integer

Indicates the order of the sections

group_id

integer

The identifier of the group that contains the section

hide_on_mobile

boolean

Determines whether the section is displayed on mobile

header_source

string

The HTML content of the header

header_align

string

The alignment of the text in the header

body_source

string

The HTML content of the body text

image_url

string

The URL of the image

image_title

string

The image caption

image_link

string

The destination URL of the image when clicked

image_align

string

The alignment of the image within the section

image_width

integer

The width of the image in pixels

image_height

integer

The height of the image in pixels

image_hide_on_mobile

boolean

Determines whether the image is displayed on mobile

image_mobile

string

Either the URL of the image or a generated name if it is in the media database

image_mobile_name

string

The original name of the image

link_url

string

The link URL

link_title

string

The link title

is_image_linked

boolean

Determines whether clicking on the image jumps to the URL defined in the link_url parameter

is_header_linked

boolean

Determines whether clicking on the header jumps to the URL defined in the link_url parameter

link_description

string

The description displayed in the individual link tracking analysis under Reporting in the Emarsys application

form_id

integer

The identifier of the form

form_title

string

The title of the form

target_audience

string

Determines the recipient group

use_social_network

string

Determines whether clickable social network icons are displayed in the section

enable_network_sharing

boolean

Determines whether network sharing is enabled

advanced_html_source

string

The advanced HTML source of the section

advanced_text_source

string

The advanced plain text source of the section

target_audience_segment_id

integer

The identifier of the target segment

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_createEmailSection" as select
        *
    from
        ( call "emarsys_connector.createEmailSection" ( in_email_id => 243551, in_section_id => 1, in_order => 2, in_group_id => 111111111, in_hide_on_mobile => true, in_header_source => 'example', in_header_align  => 'left', in_body_source => 'The section content goes here.', in_image_url => 'https://example.com/image_placeholder.php?a', in_image_align => 'right', in_image_width => 100, in_image_height => 100, in_image_hide_on_mobile => false, in_link_title => 'Link to more', in_is_image_linked => true, in_is_header_linked  => true, in_form_id => 0, in_target_audience => 'segment', in_use_social_network => 0, in_enable_network_sharing => false, in_target_audience_segment_id =>  111111111 ) ) f
;;

deleteEmailSection

Delete email section
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_section_id> (required): The identifier of the section

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_deleteEmailSection" as select
        *
    from
        ( call "emarsys_connector.deleteEmailSection" ( in_email_id => 239368, in_section_id => 1) ) f
;;

getEmailSection

The details of a section of a template-based email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_section_id> (required): The identifier of the section

Attribute

Type

Description

id

integer

The section identifier

order

integer

Indicates the order of the sections

group_id

integer

The identifier of the group that contains the section

hide_on_mobile

boolean

Determines whether the section is displayed on mobile

header_source

string

The HTML content of the header

header_align

string

The alignment of the text in the header

body_source

string

The HTML content of the body text

image_url

string

The URL of the image

image_title

string

The image caption

image_link

string

The destination URL of the image when clicked

image_align

string

The alignment of the image within the section

image_width

integer

The width of the image in pixels

image_height

integer

The height of the image in pixels

image_hide_on_mobile

boolean

Determines whether the image is displayed on mobile

image_mobile

string

Either the URL of the image or a generated name if it is in the media database

image_mobile_name

string

The original name of the image

link_url

string

The link URL

link_title

string

The link title

is_image_linked

boolean

Determines whether clicking on the image jumps to the URL defined in the link_url parameter

is_header_linked

boolean

Determines whether clicking on the header jumps to the URL defined in the link_url parameter

link_description

string

The description displayed in the individual link tracking analysis under Reporting in the Emarsys application

form_id

integer

The identifier of the form

form_title

string

The title of the form

target_audience

string

Determines the recipient group

use_social_network

string

Determines whether clickable social network icons are displayed in the section

enable_network_sharing

boolean

Determines whether network sharing is enabled

advanced_html_source

string

The advanced HTML source of the section

advanced_text_source

string

The advanced plain text source of the section

target_audience_segment_id

integer

The identifier of the target segment

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailSection" as select
        *
    from
        ( call "emarsys_connector.getEmailSection" ( in_email_id => 292386, in_section_id => 1 ) ) f
;;


getEmailSectionsList

Sections in a template-based email campaign
Parameter
<in_email_id> (required):

Attribute

Type

Description

id

integer

The section identifier

group_id

integer

The identifier of the group that contains the section

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailSectionsList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getEmailSectionsList" ( in_email_id => 292386 ) ) f
;;

updateEmailSection

Update a section of a template-based email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_section_id> (required): The identifier of the section
<in_order> (optional): Indicates the order of the sections
<in_group_id> (optional): The identifier of the group that contains the section
<in_hide_on_mobile> (optional): Determines whether the section is displayed on mobile
<in_header_source> (optional): The HTML content of the header
<in_header_align> (optional): The alignment of the text in the header
<in_body_source> (optional): The HTML content of the body text
<in_image_url> (optional): The URL of the image
<in_image_title> (optional): The image caption
<in_image_link> (optional): The destination URL of the image when clicked
<in_image_align> (optional): The alignment of the image within the section
<in_image_width> (optional): The width of the image in pixels
<in_image_height> (optional): The height of the image in pixels
<in_image_hide_on_mobile> (optional): Determines whether the image is displayed on mobile
<in_image_mobile> (optional): Either the URL of the image or a generated name if it is in the media database
<in_image_mobile_name> (optional): The original name of the image
<in_link_url> (optional): The link URL
<in_link_title> (optional): The link title
<in_is_image_linked> (optional): Determines whether clicking on the image jumps to the URL defined in the link_url parameter
<in_is_header_linked> (optional): Determines whether clicking on the header jumps to the URL defined in the link_url parameter
<in_link_description> (optional): The description displayed in the individual link tracking analysis under Reporting in the Emarsys application
<in_form_id> (optional): The identifier of the form
<in_form_title> (optional): The title of the form
<in_target_audience> (optional): Determines the recipient group
<in_use_social_network> (optional): Determines whether clickable social network icons are displayed in the section
<in_enable_network_sharing> (optional): Determines whether network sharing is enabled
<in_advanced_html_source> (optional): The advanced HTML source of the section
<in_advanced_text_source> (optional): The advanced plain text source of the section
<in_target_audience_segment_id> (optional): The identifier of the target segment

Attribute

Type

Description

id

integer

The section identifier

order

integer

Indicates the order of the sections

group_id

integer

The identifier of the group that contains the section

hide_on_mobile

boolean

Determines whether the section is displayed on mobile

header_source

string

The HTML content of the header

header_align

string

The alignment of the text in the header

body_source

string

The HTML content of the body text

image_url

string

The URL of the image

image_title

string

The image caption

image_link

string

The destination URL of the image when clicked

image_align

string

The alignment of the image within the section

image_width

integer

The width of the image in pixels

image_height

integer

The height of the image in pixels

image_hide_on_mobile

boolean

Determines whether the image is displayed on mobile

image_mobile

string

Either the URL of the image or a generated name if it is in the media database

image_mobile_name

string

The original name of the image

link_url

string

The link URL

link_title

string

The link title

is_image_linked

boolean

Determines whether clicking on the image jumps to the URL defined in the link_url parameter

is_header_linked

boolean

Determines whether clicking on the header jumps to the URL defined in the link_url parameter

link_description

string

The description displayed in the individual link tracking analysis under Reporting in the Emarsys application

form_id

integer

The identifier of the form

form_title

string

The title of the form

target_audience

string

Determines the recipient group

use_social_network

string

Determines whether clickable social network icons are displayed in the section

enable_network_sharing

boolean

Determines whether network sharing is enabled

advanced_html_source

string

The advanced HTML source of the section

advanced_text_source

string

The advanced plain text source of the section

target_audience_segment_id

integer

The identifier of the target segment

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_updateEmailSection" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.updateEmailSection" ( in_email_id => 243551, in_section_id => 1, in_order => 2, in_group_id => 111111111, in_hide_on_mobile => true, in_header_source => 'example', in_header_align  => 'left', in_body_source => 'The section content goes here.', in_image_url => 'https://example.com/image_placeholder.php?a', in_image_align => 'right', in_image_width => 100, in_image_height => 100, in_image_hide_on_mobile => false, in_link_title => 'Link to more', in_is_image_linked => true, in_is_header_linked  => true, in_form_id => 0, in_target_audience => 'segment', in_use_social_network => 0, in_enable_network_sharing => false, in_target_audience_segment_id =>  111111111 ) ) f
;;

Templates

 

getEmailTemplate

The data of an email template
Parameter
<in_template_id> (required): The template identifier

Attribute

Type

Description

id

integer

The template identifier

name

string

The template name

group_id

integer

The group identifier

group_name

string

The group name

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailTemplate" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getEmailTemplate" ( in_template_id => 188846871 ) ) f
;;

getEmailTemplatesList

Email templates
Parameter

Attribute

Type

Description

id

integer

The template identifier

name

string

The template name

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailTemplatesList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getEmailTemplatesList" ( ) ) f
;;
 

Media Database

deleteFile

Delete file
Parameter
<in_file_id> (required): The identifier of the field

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_deleteFile" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteFile" ( in_file_id => 173096 ) ) f
;;

createFolder

New folder

Parameter
<in_name> (required): The name of the new folder
<in_parent> (required): The identifier of the parent folder

Attribute

Type

Description

id

integer

The identifier of the created folder

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_createFolder" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.createFolder" ( in_name => 'TEST_SUB_FOLDER', in_parent => 13659 ) ) f         
;; 

getFilesList

A list of all media files in the Media Database
Parameter
<in_file_id> (optional): The identifier of the file
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The identifier of the file

folder

integer

The identifier of the folder that contains the file

filename

string

The name of the file

size

integer

The file size in bytes

original_name

string

The original name of the file before upload

url

string

The accessible URL of the file

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_getFilesList" as select
*
from
( call "emarsys_connector.getFilesList" ( in_folder => 251029 ) ) f
;;

getFoldersList

All folders
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The identifier of the folder

parent

integer

The identifier of the parent folder

name

string

The name of the folder

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getFoldersList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getFoldersList" ( ) ) f
;;

uploadFile

Uploads a file to the Media Database
Parameter
<in_filename> (required): The full name of the file with extension
<in_folder> (optional): The identifier of the Media Database folder to upload into
<in_preserve_filename> (optional): Set to 1 to keep the original file name

Attribute

Type

Description

id

integer

The identifier of the file

folder

integer

The identifier of the folder that contains the file

filename

string

The name of the file

size

integer

The file size in bytes

original_name

string

The original name of the file before upload

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_uploadFile" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.uploadFile" ( in_filename => 'p.jpg', in_folder => 16025, in_preserve_filename => 1 ) ) f         
;;

New tracked link in the specified section of an email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_section_id> (required): The identifier of the section that contains the tracked link
<in_url> (required): The tracked link included in the email campaign

Attribute

Type

Description

id

integer

The link identifier

section_id

integer

The identifier of the section that contains the tracked link

url

string

The tracked link included in the email campaign

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_connector_example"."example_сreateTrackedLink" as select
*
from
( call "emarsys_connector.сreateTrackedLink" (in_email_id => 239368, in_section_id => 1, in_url => 'http://example.com') ) f
;;

Delete all tracked links
Parameter
<in_email_id> (required): The identifier of the email campaign

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
create view "emarsys_connector_example"."example_deleteAllTrackedLinks" as select
*
from
( call "emarsys_connector.deleteAllTrackedLinks" ( in_email_id => 239368 ) ) f
;;

Delete tracked link
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_link_id> (optional): The identifier of the tracked link

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_deleteTrackedLink" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.deleteTrackedLink" ( in_email_id => 239368, in_link_id => 1 ) ) f
;;

The tracked link of an email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_link_id> (required): The identifier of the tracked link

Attribute

Type

Description

id

integer

The identifier of the tracked link

section_id

integer

The identifier of the email campaign section of the URL

url

string

The URL of the tracked link

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailTrackedLink" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getEmailTrackedLink" ( in_email_id => 213110, in_link_id => 2 ) ) f
;;

All tracked links of an email campaign
Parameter
<in_email_id> (required): The identifier of the email campaign

Attribute

Type

Description

id

integer

The identifier of the tracked link

section_id

integer

The identifier of the email campaign section of the URL

url

string

The URL of the tracked link

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailTrackedLinksList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getEmailTrackedLinksList" ( in_email_id => 213110 ) ) f
;;

getLinkCategoriesList

The categories of links used in emails based on their type
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The category indentifier

name

string

The category name

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getLinkCategoriesList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getLinkCategoriesList" ( ) ) f
;;

Update tracked link
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_link_id> (required): The tracked link identifier
<in_url> (required): The URL of the tracked link

Attribute

Type

Description

id

integer

The identifier of the tracked link

section_id

integer

The section identifier

url

string

The URL of the tracked link

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_updateTrackedLink" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.updateTrackedLink" (in_email_id => 239368, in_link_id => 1, in_url => 'http://example.com') ) f
;;

Launches

launchEmailCampaign

Launch Email Campaign
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_schedule> (optional): Schedule
<in_timezone> (optional): Time zone

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_launchEmailCampaign" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.launchEmailCampaign" ( in_email_id => 255244 ) ) f
;; 

listEmailCampaignLaunches

All launches of an email campaign
Parameter
<in_email_id> (required):

Attribute

Type

Description

id

integer

The launch identifier

done

string

The status of the launch

launch_date

date

The date of the launch

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_listEmailCampaignLaunches" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.listEmailCampaignLaunches" ( in_email_id => 239368 ) ) f
;; 

getDeliveryStatus


The delivery status of an email campaign
Parameter
<email_id> (required): The identifier of the email campaign
<last_id> (optional): Helps you with the pagination of the results
<launch_id> (optional): The identifier of the launch

Attribute

Type

Description

id

integer

The identifier of the email campaign

user_id

integer

The user identifier

email

string

E-mail

status

string

The status of the campaign

mail_type

string

The type of the email

bounce_reason

string

The bounce type

bounced

boolean

Bounced

launched

timestamp

Launched

SQL
CREATE VIEW "emarsys_connector_example"."example_getDeliveryStatus" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.getDeliveryStatus" ( in_email_id => 239368 ) ) f
;;

getEmailCampaignContentURL

The URL of a Launched Email Campaign Content
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_key_id> (required): Identifies the contact by their id
<in_key_value> (required): The key value

Attribute

Type

Description

url

string

The URL of the online version

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
CREATE VIEW "emarsys_connector_example"."example_getEmailCampaignContentURL" AS SELECT
        f.*
    FROM
        ( CALL "emarsys_connector.getEmailCampaignContentURL" ( in_email_id => 239368, in_key_id => '3', in_key_value => 'clint.barton@example.com' ) ) f
;;

getEmailCampaigns

Existing email campaigns
Parameter
<status> (optional): Status of the campaign
<launched> (optional): Filters campaigns by their launch status
<contactlist> (optional): Identifier of the contact list
<showdeleted> (optional): Filters deleted campaigns
<fromdate> (optional): Lists campaigns created after the specified date
<todate> (optional): Lists campaigns created before the specified date
<root_campaign_id> (optional): Identifier of the root campaign ID
<template> (optional): Identifier of the template
<content_type> (optional): Type of the campaign
<campaign_type> (optional): Type of the campaign
<parent_campaign_id> (optional): Identifier of the parent campaign
<behavior_channel> (optional): Channel type
<email_category> (optional): Identifier of the campaign
<is_rti> (optional): Specifies whether the campaign supports Real Time Interactions

Attribute

Type

Description

id

string

Email identifier

language

string

Email language

created

string

Creation date of the email

deleted

string

Deletion date of the email (if applicable)

fromemail_host

string

Indicates whether Emarsys reply mail management is used (emarsys) or not (external)

name

string

Name of the email

status

string

Status of the email

api_status

string

Launch status of the campaign

api_error

string

Any specific error related to the endpoints or methods

fromemail

string

Sender of the email

fromname

string

Name of the email sender

subject

string

Subject line of the email

email_category

string

Category identifier of the email

filter

string

Identifier of the associated segment included from the recipient source

contactlist

string

Identifier of the associated contact list included in the recipient source

template

string

Identifier of the email template

cc_list

integer

Identifier of the contact list to receive a copy of the email

source

string

Origin of the recipient

html_source

string

HTML source of the email

text_source

string

Plain text source of the email

content_type

string

Email content type

root_campaign_id

string

Identifier of the root campaign

version_name

string

Name of the root campaign

features

string

Features enabled in the campaign

getResponseSummary

The summary of the responses
Parameter
<campaign_ids> (optional): Campaign ids, comma-delimited list of ids
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

campaign_id

integer

Campaign id

sent

integer

The number of emails already sent from our servers

planned

integer

The total number of contacts assigned to the launch

soft_bounces

integer

The number of emails returned to sender due to temporary problems

hard_bounces

integer

The number of emails returned to sender due to permanent problems

block_bounces

integer

The number of emails returned to sender due to being blocked by spam filters

opened

integer

The number of emails returned to sender due to being blocked by spam filters

privacyOpened

integer

Privacy opened

unsubscribe

integer

The number of clicks on the unsubscribe link

total_clicks

integer

The number of total clicks on links tracked by the Emarsys application

unique_clicks

integer

The number of unique clicks on links tracked by the Emarsys application

complained

integer

The number of recipients who marked the email as spam in their email client

launches

integer

The number of launches in the given time range

SQL
CREATE VIEW "emarsys_connector_example"."example_getResponseSummary" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getResponseSummary" ( in_email_id => 213110 ) ) f
;;
 

getResponsesResult

Email response metrics and deliverability results
Parameter
<in_type> (required): The response metric type
<campaign_id> (optional): Campaign id
<in_start_date> (optional): Returns results from the specified date
<in_end_date> (optional): Returns results to the specified date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

response_date

date


contact_id

integer

Contact id


SQL
CREATE VIEW "emarsys_connector_example"."example_getResponsesResult" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getResponsesResult" ( in_type => 'bounced' ) ) f
;;

previewEmailCampaignContents

Preview Email Campaign Contents
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_version> (required): The content type of the response

Attribute

Type

Description

data

string

The HTML, plain text or mobile version of the email

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_examples"."example_previewEmailCampaignContents" as select
f.*
from
( call "emarsys.previewEmailCampaignContents" ( in_email_id => 239368, in_version => 'html' ) ) f;;

sendTestEmail

Send a test email
Parameter
<in_email_id> (required): The identifier of the email campaign
<in_recipientlist> (optional): The list of recipient email addresses
<in_filter_id> (optional): The identifier of the recipient segment
<in_contactlist_id> (optional): The identifier of the recipient contact list
<in_subject> (optional): Subject

Attribute

Type

Description

data

string

Result

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request


SQL
create view "emarsys_connector_example"."example_sendTestEmail" as select
f.*
from
( call "emarsys_connector.sendTestEmail" ( in_email_id => 239368 ) ) f
;;

unsubscribeEmailCampaignContact

Unsubscribe a contact from an email campaign
Parameter
<in_launch_list_id> (required): The identifier of contacts who clicked the unsubscribe link
<in_email_id> (required): The identifier of the email campaign
<in_contact_uid> (required): The contact identifier uid

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_unsubscribeEmailCampaignContact" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.unsubscribeEmailCampaignContact" ( in_email_id => 239368, in_launch_list_id => 1, in_contact_uid => '123123123') ) f         
;;

Segments


getSegmentContactsCount

The number of contacts in the specified segment
Parameter
<in_segment_id> (optional): Segment id
<segment_id_table> (optional): The table name with segment list identifier data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

segment_id

integer

Segment id

count

integer

The current number of contacts in the segment

reply_code

integer

The Emarsys response code

reply_text

string

The summary of the response


SQL
CREATE VIEW "emarsys_connector_example"."example_getSegmentContactsCount" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getSegmentContactsCount" ( in_segment_id => 199084 ) ) f
;;

 

getSegmentContactsList

Returns a list of contacts after a specific segment (i.e. filter) was applied.


SQL
getSegmentContactsList(integer <in_segment_id>)

Parameter:   

<in_segment_id(required): ID of the segment.


SQL
CREATE VIEW "emarsys_connector_example"."example_getSegmentContactsList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getSegmentContactsList" ( in_segment_id => 199084 ) ) f
;;

 

getSegmentsList

Segments List
Parameter
<segment_id> (optional): The segment identifier
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

id

integer

The segment identifier

name

string

The name of the segment

type

string

The segment type

tags

string

Additional information about the segment

criteriaTypes

string

The criteria types used in the segment

baseContactListId

integer

The identifier of contact list the segment is based on

predefinedSegmentId

integer

The identifier of the predefined segment

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
CREATE VIEW "emarsys_connector_example"."example_getSegmentsList" AS SELECT
        *
    FROM
        ( CALL "emarsys_connector.getSegmentsList" ( ) ) s
;;

Program

startProgram

Start program
Parameter
<in_node_type> (required): The node type
<in_resource_id> (required): The identifier of the resource
<in_contact_list_id> (optional): The identifier of the contact list
<in_contact_id> (optional): The identifier of the contact
<in_data> (optional): Data

Attribute

Type

Description

reply_code

integer

The Emarsys response code

reply_text

string

Additional information on the status of the request

SQL
create view "emarsys_examples"."example_w_startProgram" as select
*
from
( call "emarsys.startProgram" ( in_node_type => 'example-event', in_resource_id => 42 ) ) f;;

getProgramResources

All external services and their resources
Parameter
<in_service_id> (optional): The identifier of the external service
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute

Type

Description

replyCode

integer

The Emarsys response code

replyText

string

Additional information on the status of the request

service_id

string

The identifier of the external service

customer_id

integer

The identifier of the customer

program_id

integer

The identifier of the program

node_id

integer

The identifier of the node

resource_id

string

The identifier of the resource


Text alignment of the header.Can be left, center, right.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.