Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Create the default/institution template
ENDPOINTS
post
/db-alerts-management/v1/alert-templates
Header parameters
Collapse
Authorization
string
required
An OAuth2 access token that authorizes this request. Must be in the format Bearer {ACCESS_TOKEN}
transactionId
string
required
transactionId
roles
array
no
roles
institutionId
string
no
institutionId
Body parameters
Collapse
Query parameters
Collapse
default
boolean
no
default
Responses
Collapse
201
Template created successfully
Response Body
{ "title": "AlertTemplateResource", "type": "object", "properties": { "alertTypeName": { "type": "string" }, "alertTypeResourceId": { "type": "integer", "format": "int64" }, "externalSystem": { "type": "string" }, "institutionId": { "type": "string" }, "lastUpdatedDttm": { "type": "string" }, "locale": { "type": "string" }, "state": { "type": "string", "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ] }, "templateContents": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelContent" } }, "variableMap": { "type": "object", "additionalProperties": { "type": "string" } } } }
400
Bad request
Response Body
{}
401
Unauthorized
Response Body
{}
403
Forbidden
Response Body
{}
404
Resource not found
Response Body
{}
500
Internal error
Response Body
{}
CURL REQUEST
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/db-alerts-management/v1/alert-templates' \
-H 'institutionid: SOME_STRING_VALUE' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"alertTypeName": "string",
"alertTypeResourceId": 0,
"externalSystem": "string",
"institutionId": "string",
"lastUpdatedDttm": "string",
"locale": "string",
"state": "DRAFT",
"templateContents": [
{
"alertTemplateResourceId": 0,
"channelType": "EMAIL",
"templateContent": "string",
"templateContentType": "EMAIL_SUBJECT"
}
],
"variableMap": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}';RESPONSE
{ "title": "AlertTemplateResource", "type": "object", "properties": { "alertTypeName": { "type": "string" }, "alertTypeResourceId": { "type": "integer", "format": "int64" }, "externalSystem": { "type": "string" }, "institutionId": { "type": "string" }, "lastUpdatedDttm": { "type": "string" }, "locale": { "type": "string" }, "state": { "type": "string", "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ] }, "templateContents": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelContent" } }, "variableMap": { "type": "object", "additionalProperties": { "type": "string" } } } }
{}
{}
{}
{}
{}
