Synapcus Developers (EN)

Serial Letter (sle)

Serial letter entity represents a marketing task, mostly inside of a marketing campaign with a predefined content (HTML), and sending parameters.

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

Name

Type

Label

Description

form *

String

Form

Represents the entity form. Will always be "sle".

sle_name *

String

Name

The object name

sle_body *

HTML/String


Represents the body content of the serial letter

sle_cpg_name *

String


Represents the parent entity name under which the serial letter has been created and referenced.

sle_cpg_nr *

String


Represents the parent entity number under which the serial letter has been created and referenced. Will always be "C-YYxxxx" as serial number, that automatically increments by 1 as each new record is added. (e.g. "C-190007").

sle_cpg_unid *

String


The unique ID of the parent entity under which the serial letter has been created and referenced.

sle_created_from *

String


The parent entity type "under which the serial letter has been created and referenced.

sle_elem_form

String


The form of the parent element. 

sle_elem_unid

String


The unique ID of the parent element.

sle_sender_name *

String


Represents the sender full name

sle_sender_unid *

String


Represents the unique ID of the sender document.

sle_send_time *

Date/Time


The date and time of 

sle_state *

String


Represents the state of the activity as a number. (e.g. "100", "200")

sle_state_text

String


Represents the state of the activity as label. 

sle_subject

String


The title of the serien letter

sle_type

String


The type of the objekt. (e.g. "memo")

QEE classes level

The class representing the Serial Letter is QEESle

Inherits from: QEEObject

REST level

The endpoints dealing with Serial Letter are:

xrSle (GET, POST, PUT, DELETE)

xrSles (GET, PUT, DELETE)