Send Email

Using this API, email will be sent to the user's based on the template which is specified in the mailtype.

Send Welcome Email

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
*mailType	String	Specify the mail type for template. Value should be "WELCOME"
*portalUrl	String	Specify the Portal access url
*iosLink	String	Specify the iOS link
*androidLink	String	Specify Android link

Sample Request

{
    "mailType": "WELCOME",
    "iosLink": "https://xxxx.xxx.com",
	"androidLink": "https://xxxx.xxx.com",
	"portalUrl": "https://xxxx.xxx.com"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
400	BAD_REQUEST	Portal url is missing, Android Link is missing, Ios Link is missing, and Mail type or text body is required.
401	Unauthorized	HTTP 401 Unauthorized

Send Tenant Information Email

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

NOTE: API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
*mailType	String	Specify the mail type for template. Value should be "TENANT_INFO"
userName	String	Specify the Username
tenantName	String	Specify Tenant name
portalUrl	String	Specify the Portal access url

Sample Request

{
    "mailType": "TENANT_INFO",
    "tenantName": "xxx_tenant",
    "userName": "xx_user",
    "portalUrl": "https://xxxx.portal.com"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
400	BAD_REQUEST	Tenant name is missing, User name missing, Portal url is missing, and Mail type or text body is required.
401	Unauthorized	HTTP 401 Unauthorized

Send Verification Email

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

NOTE: API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
*mailType	String	Specify the mail type for template. Value should be "VERIFY"
redirectUri	String	Specify the URI where user needs to land after completing the process
appName	String	Application Name (Note: App should accept the redirect URI)
portalUrl	String	Specify the Tenant portal access url
supportEmail	String	Specify the Contact Support email if any.

Sample Request

{
    "mailType": "VERIFY",
    "redirectUri": "https://xxxx.xxx.xxxx.test.xxxx.com/",
    "appName": "account",
    "portalUrl": "https://xxxx.xxx.com",
    "supportEmail": "xxxsupport@xxx.com"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
400	BAD_REQUEST	Mail type or text body is required.
401	Unauthorized	HTTP 401 Unauthorized

Send Forgot Password Email

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

NOTE: API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
*mailType	String	Specify the mail type for template. Value should be "FORGOT_PASSWORD"
redirectUri	String	Specify the URI where user needs to land after completing the process
appName	String	Application Name (Note: App should accept the redirect URI)
supportEmail	String	Specify the Contact Support email. When not provide will display the default mail

Sample Request

{
    "mailType": "FORGOT_PASSWORD",
    "redirectUri": "https://xxxx.xxx.xxxx.test.xxxx.com/",
    "appName": "account",
    "supportEmail": "xxxsupport@xxx.com"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
400	BAD_REQUEST	Mail type or text body is required.
401	Unauthorized	HTTP 401 Unauthorized

Send Required Actions Verification Email

Required actions for a particular user can be configured and sent through a verification email as well. The user will be asked to perform all the required actions set for him through the email.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

NOTE: API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
*mailType	String	Specify the mail type for template. Value should be "VERIFY"
iosLink	String	Specify the iOS link
androidLink	String	Specify Android link
requiredactions	Array of string	Specify the required actions to be verified for the user.

Sample Request

{
    "mailType": "VERIFY",
    "iosLink": "https://xxxx.xxx.com",
	"androidLink": "https://xxxx.xxx.com",
    "requiredactions":["required-action"]
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 7
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
400	BAD_REQUEST	Mail type or text body is required.
401	Unauthorized	HTTP 401 Unauthorized