Synapcus Developers (EN)

Marketing Lists / Target Groups (mkl)

Marketing Lists or Target Groups entity store informations about group of persons which are targeted through the marketing process. They can have a static or dynamic character.

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 "mkl".

mkl_name *

String

Name

The object name

mkl_nr *

String


Represents the marketing list number. Will always be "M-YYxxxx" as serial number, that automatically increments by 1 as each new record is added.

mkl_resp_name

String


Represents the name of the responsible person document responsible for the marketing list as fist name and last name.

mkl_resp_unid

String


Represents the unique ID of the person document responsible for the marketing list.

mkl_state

Number


Represents the state of the marketing list as a number.

mkl_state_text

String


Represents the state of the marketing list as a text.

mkl_type

String


Represents the type of the marketing list as a code.

mkl_type_text

String


Represents the type of the marketing list as text

mkl_desc

HTML String


Fully description of the object

mkl_freezed

String


Stipulates if the list is blocked or not, (e.g. "false", "true")

mkl_last_use

Date/Time


Stipulates the date and time of the last use of the object.

mkl_objective

String


Represents the target of the object.

mkl_permkls_name

String


Represents a list of target persons. 

QEE classes level

The class representing the Marketing Lists / Target Groups is QEEMkl

Inherits from: QEEObject

REST level

The endpoints dealing with Marketing Lists / Target Groups are:

xrMkl (GET, POST, PUT, DELETE)

xrMkls (GET, PUT, DELETE)