Messagetemplateapiv1

activatedboolean

Description for activated in MessageTemplateApiV1

authorizationstring

Description for authorization in MessageTemplateApiV1

Possible values: [NO_AUTHORIZATION, BASIC_AUTHORIZATION]

contentTypestring

Description for contentType in MessageTemplateApiV1

Possible values: [PLAIN_TEXT, APPLICATION_JSON, APPLICATION_XML]

creationDatestring

the date and time when this template was created

customFilter object

Description for customFilter in MessageTemplateApiV1

customConfigurationInfo object

Description for customConfigurationInfo in CustomFilterApiV1

creationDatestring

the date on which this configuration was created

dataViewTypestring

the type of entity this configuration is for

Possible values: [PORTAL_ACCOUNT_TRANSACTION, LOANS_AGING_ANALYSIS, CLOSED_ACCOUNTS, CLIENT_OVERVIEW, ADMIN_CENTRES, USER_NOTIFICATION_MESSAGES, LINE_OF_CREDIT, USER_OVERVIEW, CENTRE_OVERVIEW, REPAYMENT_REPAYMENTS_COLLECTION, GROUP_OVERVIEW, ACTIVITIES_LOOKUP, TRANSACTION, ADMIN_BRANCHES, GROUP, BRANCH_OVERVIEW, NOTIFICATION_MESSAGE, PORTFOLIO_REPORTS, GROUP_NOTIFICATION_MESSAGES, LOAN_ACCOUNT_SECURITIES_OVERVIEW, LINE_OF_CREDIT_OVERVIEW, CURRENCIES, REPAYMENT, TILL_TRANSACTIONS, ALL_TASKS, CENTRE, BRANCH, INDEX_RATES_LIST, USER_TASKS, DOCUMENT_TEMPLATES, SAVINGS_TRANSACTIONS_LOOKUP, LOAN_ACCOUNT_OVERVIEW, DEPOSITS_COLLECTION, USER, ADMIN_USERS, GROUP_TASKS, CLIENT, LOAN_TRANSACTIONS_LOOKUP, LOANS, LOANS_REPAYMENTS_COLLECTION, CLIENT_TASKS, OVERDRAFTS_AGING_ANALYSIS, LOAN_ACCOUNT_FUNDING_OVERVIEW, SAVINGS, SAVINGS_OVERVIEW, JOURNAL_ENTRY, CLIENT_NOTIFICATION_MESSAGES]

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

indexInListnumber

if more than one configuration exists for a given type, this is its index in the list

lastModifiedDatestring

the date on which this configuration was last modified

namestring

the name for this configuration

sharedboolean

whether this configuration is private or can be used by other users of the system

userKeystring

the encoded key of the Mambu user who created this configuration

encodedKeystring

Description for encodedKey in CustomFilterApiV1

filterConstraints object[]

Description for filterConstraints in CustomFilterApiV1

Array [

customFieldKeystring

Description for customFieldKey in CustomFilterConstraintApiV1

dataFieldTypestring

Description for dataFieldType in CustomFilterConstraintApiV1

Possible values: [NATIVE, CUSTOM]

dataFieldValuestring

Description for dataFieldValue in CustomFilterConstraintApiV1

dataItemTypestring

Description for dataItemType in CustomFilterConstraintApiV1

Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]

dataTypestring

Description for dataType in CustomFilterConstraintApiV1

Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

encodedKeystring

Description for encodedKey in CustomFilterConstraintApiV1

filterElementstring

Description for filterElement in CustomFilterConstraintApiV1

Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

groupNumbernumber

Description for groupNumber in CustomFilterConstraintApiV1

indexnumber

Description for index in CustomFilterConstraintApiV1

linkingOperatorstring

Description for linkingOperator in CustomFilterConstraintApiV1

Possible values: [OR, AND]

secondValuestring

Description for secondValue in CustomFilterConstraintApiV1

valuestring

Description for value in CustomFilterConstraintApiV1

]

encodedKeystring

the automatically generated encoded ID for this notification template

Example: 8a19b7057471f4af017472dc0fd80472

eventstring

Description for event in MessageTemplateApiV1

Possible values: [LOAN_CREATED, SAVINGS_ACCOUNT_REJECTION, SAVINGS_ACCOUNT_ACTIVATED, DATA_ACCESS_STATE_CHANGED, REPAYMENT_REMINDER, LOAN_ANTICIPATED_DISBURSEMENT, CREDIT_ARRANGEMENT_deleteD, SAVINGS_APPROVAL, PORTAL_ACTIVATED, SAVINGS_DEPOSIT, PORTAL_PASSWORD_RESET, CREDIT_ARRANGEMENT_REJECTED, LOAN_REPAYMENT_REVERSAL, SAVINGS_ACCOUNT_CLOSURE, LOAN_ACCOUNT_REJECTION, LOAN_ACCOUNT_RESCHEDULED, ACCOUNT_IN_ARREARS, LOAN_DISBURSEMENT_REVERSAL, SAVINGS_DEPOSIT_REVERSAL, CLIENT_APPROVED, LOAN_REPAYMENT, LOAN_ACCOUNT_ACTIVITY, GROUP_CREATED, LOAN_DISBURSEMENT, CREDIT_ARRANGEMENT_APPROVED, MANUAL, END_OF_DAY_PROCESSING_COMPLETED, CREDIT_ARRANGEMENT_ACCOUNT_ADDED, CLIENT_REJECTED, CLIENT_ACTIVITY, LOAN_ACCOUNT_REFINANCED, SAVINGS_CREATED, CLIENT_CREATED, LOAN_APPROVAL, GROUP_ACTIVITY, LOAN_ACCOUNT_CLOSURE, SAVINGS_WITHDRAWAL_REVERSAL, CREDIT_ARRANGEMENT_WITHDRAWN, CREDIT_ARRANGEMENT_CREATED, SAVINGS_WITHDRAWAL, SAVINGS_ACCOUNT_ACTIVITY, LOAN_ACCOUNT_WRITE_OFF, CREDIT_ARRANGEMENT_ACCOUNT_REMOVED, CREDIT_ARRANGEMENT_CLOSED]

isInUseboolean

Description for isInUse in MessageTemplateApiV1

lastModifiedDatestring

the date on which this notification template was last modified

namestring

Description for name in MessageTemplateApiV1

optionstring

Description for option in MessageTemplateApiV1

Possible values: [OPT_IN, OPT_OUT]

recipient object

Description for recipient in MessageTemplateApiV1

customField object

Description for customField in MessageTemplateRecipientApiV1

amounts object

used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score

property name*number

builtInCustomFieldIdstring

if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions

Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]

creationDatestring

the date on which this custom field definition was created

customFieldProductSettings object[]

Description for customFieldProductSettings in CustomFieldApiV1

Array [

customFieldEncodedKeystring

the key to the parent custom field definition

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isDefaultboolean

whether this field is displayed by default when creating a new record

isRequiredboolean

whether this field is required when creating a new record

linkTypestring

the type of entity this field represents a link to

Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

productKeystring

when the link type is product, this field should contain the encoded key of the linekd product

]

customFieldSelectionOptions object[]

Description for customFieldSelectionOptions in CustomFieldApiV1

Array [

constraint object

Description for constraint in CustomFieldSelectionApiV1

customFieldKeystring

Description for customFieldKey in CustomFilterConstraintApiV1

dataFieldTypestring

Description for dataFieldType in CustomFilterConstraintApiV1

Possible values: [NATIVE, CUSTOM]

dataFieldValuestring

Description for dataFieldValue in CustomFilterConstraintApiV1

dataItemTypestring

Description for dataItemType in CustomFilterConstraintApiV1

dataTypestring

Description for dataType in CustomFilterConstraintApiV1

Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

encodedKeystring

Description for encodedKey in CustomFilterConstraintApiV1

filterElementstring

Description for filterElement in CustomFilterConstraintApiV1

groupNumbernumber

Description for groupNumber in CustomFilterConstraintApiV1

indexnumber

Description for index in CustomFilterConstraintApiV1

linkingOperatorstring

Description for linkingOperator in CustomFilterConstraintApiV1

Possible values: [OR, AND]

secondValuestring

Description for secondValue in CustomFilterConstraintApiV1

valuestring

Description for value in CustomFilterConstraintApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID of this selectable item

scorenumber

the score assigned to this selection

valuestring

display name of this option

]

customFieldSet object

Description for customFieldSet in CustomFieldApiV1

builtInTypestring

if this set is part of the set of built-in custom field sets, its type will be shown here

Possible values: [DETAILS, GENERAL]

createdDatestring

the date and time when this custom field set was created

customFields object[]

an array of custom field definitions included in this custom field set

Array [

]

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID of this custom field set

indexInListnumber

for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values

lastModifiedDatestring

the date on which this custom field set was last modified

namestring

the name of this custom field set

notesstring

any notes regarding this custom field set

typestring

the entity type that this custom field definition is attached to

Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

usagestring

whether this custom field set can only be used once, or added multiple times to the same entity

Possible values: [SINGLE, GROUPED]

dataTypestring

the type of custom field definition

Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]

descriptionstring

a brief description of this custom field definition

editRights object

Description for editRights in CustomFieldApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID for this custom field definition

indexInListnumber

Description for indexInList in CustomFieldApiV1

isDefaultboolean

whether this field will be included by default on new records

isRequiredboolean

whether this field is required when creating a new record

lastModifiedDatestring

the date on which this custom field definition was last modified

namestring

the name of this custom field definition

statestring

whether this field is available for use or has been deactivated

Possible values: [DEACTIVATED, NORMAL]

typestring

the type of data this custom field definition will contain

uniqueboolean

whether the data in this custom field definition needs to be a unique value

validationPatternstring

a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example @@-##-$$$

valueLengthstring

whether this field needs to support a large number of characters

Possible values: [SHORT, LONG]

valuesstring[]

a list of possible values when the field is a selection field

viewRights object

Description for viewRights in CustomFieldApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

groupRole object

Description for groupRole in MessageTemplateRecipientApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

namestring

the name of this role

recipientTypestring

Description for recipientType in MessageTemplateRecipientApiV1

Possible values: [CREDIT_OFFICER, CUSTOM_FIELD, GROUP_ROLE, CLIENT]

requestTypestring

Description for requestType in MessageTemplateApiV1

Possible values: [HEAD, delete, post, get, put, patch]

subjectstring

Description for subject in MessageTemplateApiV1

targetTypestring

Description for targetType in MessageTemplateApiV1

Possible values: [LOANS, GROUP, SAVINGS, DATA_ACCESS, BACKGROUND_PROCESS, CLIENT]

templatestring

Description for template in MessageTemplateApiV1

topicstring

Description for topic in MessageTemplateApiV1

triggerstring

Description for trigger in MessageTemplateApiV1

Possible values: [AUTOMATIC, MANUAL]

triggerDaysnumber

Description for triggerDays in MessageTemplateApiV1

typestring

Description for type in MessageTemplateApiV1

Possible values: [EVENT_STREAM, TASK, SMS, EMAIL, WEB_HOOK]

urlstring

Description for url in MessageTemplateApiV1

usernamestring

Description for username in MessageTemplateApiV1

Messagetemplateapiv1
{
  "activated": true,
  "authorization": "NO_AUTHORIZATION",
  "contentType": "PLAIN_TEXT",
  "creationDate": "string",
  "customFilter": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "shared": true,
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "event": "LOAN_CREATED",
  "isInUse": true,
  "lastModifiedDate": "string",
  "name": "string",
  "option": "OPT_IN",
  "recipient": {
    "customField": {
      "amounts": {},
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "groupRole": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string"
    },
    "recipientType": "CREDIT_OFFICER"
  },
  "requestType": "HEAD",
  "subject": "string",
  "targetType": "LOANS",
  "template": "string",
  "topic": "string",
  "trigger": "AUTOMATIC",
  "triggerDays": 0,
  "type": "EVENT_STREAM",
  "url": "string",
  "username": "string"
}