Use a template to send email to a user
post
/ec-notifications-svc/rest/v4.0/email/{templatetype}
Sends email to users with the specified template. Supports a list of study role ids in addition to email addresses. The recipients are restricted to the sites they have access to. The template is stored in the configuration PDB.
Request
Path Parameters
-
templatetype(required): string
Name of template to use to send email. Valid values are taken from email template configuration database.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
emailAddresses: array
emailAddresses
-
placeHolderImageMap: object
placeHolderImageMap
Additional Properties Allowed: additionalProperties
-
placeHolderValueMap: object
placeHolderValueMap
Additional Properties Allowed: additionalProperties
-
siteId: string
-
studyRoleIds: array
studyRoleIds
-
subject(required): string
-
users: array
users
Response
Supported Media Types
- application/json
200 Response
Success.
400 Response
Bad request.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Internal server error.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object