Jump to

• Request
• Response

V3.0

post

/ec-notifications-svc/rest/v3.0/email/{templatetype}

Sends email to users with the specified template. Supports a list of study role IDs in addition to email addresses. Relative to v2.0: Support studyRoleId to send notifications.

Request

Path Parameters

• templatetype(required): string
  Name of the template to use to send email. Valid values are taken from email template configuration database, Allowed Values: CompletedTrainingTemplate, DefaultTrainingTemplate_L10n, CompletedTrainingTemplate_L10n, WithoutStudyTrainingTemplate, AssignedTrainingTemplate

  Example:

  DefaultTrainingTemplate

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Supporting study role based targeting in addition to direct email addresses and users.

Show Source

• emailAddresses: array emailAddresses
  Additional recipient email addresses not associated with users
• placeHolderImageMap: object placeHolderImageMap
  Map of placeholder image variables to URLs or resource identifiers
• placeHolderValueMap: object placeHolderValueMap
  Map of placeholder variables to be replaced in the template body
• studyRoleIds: array studyRoleIds
  List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)
• subject(required): string
  Email subject line to use when sending the template

  Example: Training Status Reminder
• users: array users
  List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)

{
    "required":[
        "subject"
    ],
    "type":"object",
    "properties":{
        "subject":{
            "type":"string",
            "description":"Email subject line to use when sending the template",
            "example":"Training Status Reminder"
        },
        "users":{
            "type":"array",
            "description":"List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)",
            "example":[
                "C5770247BEF54CE0923B7C7CA3B659C8",
                "DBF0480DD86446CE8482BE016726393C"
            ],
            "items":{
                "type":"string",
                "description":"List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)",
                "example":"[\"C5770247BEF54CE0923B7C7CA3B659C8\",\"DBF0480DD86446CE8482BE016726393C\"]"
            }
        },
        "placeHolderValueMap":{
            "type":"object",
            "description":"Map of placeholder variables to be replaced in the template body",
            "example":{
                "userTrainingDetails":" ",
                "redirectUrl":"",
                "username":"system",
                "studyName":"AutomationStudy"
            }
        },
        "placeHolderImageMap":{
            "type":"object",
            "description":"Map of placeholder image variables to URLs or resource identifiers",
            "example":{
                "image5":"NOTIFICATION.EMAIL.IMAGE5",
                "image3":"NOTIFICATION.EMAIL.IMAGE3",
                "image4":"NOTIFICATION.EMAIL.IMAGE4",
                "image1":"NOTIFICATION.EMAIL.IMAGE1",
                "image2":"NOTIFICATION.EMAIL.IMAGE2"
            }
        },
        "emailAddresses":{
            "type":"array",
            "description":"Additional recipient email addresses not associated with users",
            "example":"[\"[e-mail]\"",
            "items":{
                "type":"string",
                "description":"Additional recipient email addresses not associated with users",
                "example":"[\"[e-mail]\""
            }
        },
        "studyRoleIds":{
            "type":"array",
            "description":"List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)",
            "example":[
                "1BC29B36F5D64B1B95F4BD32CEA481BE",
                "8F14E45FC1EA167A5A36D5DD4BEA2543"
            ],
            "items":{
                "type":"string",
                "description":"List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)",
                "example":"[\"1BC29B36F5D64B1B95F4BD32CEA481BE\",\"8F14E45FC1EA167A5A36D5DD4BEA2543\"]"
            }
        }
    },
    "description":"Supporting study role based targeting in addition to direct email addresses and users."
}

Nested Schema : emailAddresses

Type: array

Additional recipient email addresses not associated with users

Show Source

• Array of: string
  Additional recipient email addresses not associated with users

  Example: ["[e-mail]"

{
    "type":"array",
    "description":"Additional recipient email addresses not associated with users",
    "example":"[\"[e-mail]\"",
    "items":{
        "type":"string",
        "description":"Additional recipient email addresses not associated with users",
        "example":"[\"[e-mail]\""
    }
}

Example:

["[e-mail]"

Nested Schema : placeHolderImageMap

Type: object

Map of placeholder image variables to URLs or resource identifiers

Example:

{
    "image5":"NOTIFICATION.EMAIL.IMAGE5",
    "image3":"NOTIFICATION.EMAIL.IMAGE3",
    "image4":"NOTIFICATION.EMAIL.IMAGE4",
    "image1":"NOTIFICATION.EMAIL.IMAGE1",
    "image2":"NOTIFICATION.EMAIL.IMAGE2"
}

Nested Schema : placeHolderValueMap

Type: object

Map of placeholder variables to be replaced in the template body

Example:

{
    "userTrainingDetails":" ",
    "redirectUrl":"",
    "username":"system",
    "studyName":"AutomationStudy"
}

Nested Schema : studyRoleIds

Type: array

List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)

Show Source

• Array of: string
  List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)

  Example: ["1BC29B36F5D64B1B95F4BD32CEA481BE","8F14E45FC1EA167A5A36D5DD4BEA2543"]

{
    "type":"array",
    "description":"List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)",
    "example":[
        "1BC29B36F5D64B1B95F4BD32CEA481BE",
        "8F14E45FC1EA167A5A36D5DD4BEA2543"
    ],
    "items":{
        "type":"string",
        "description":"List of study role identifiers to target (UUID, 32-character uppercase hexadecimal string)",
        "example":"[\"1BC29B36F5D64B1B95F4BD32CEA481BE\",\"8F14E45FC1EA167A5A36D5DD4BEA2543\"]"
    }
}

Example:

[
    "1BC29B36F5D64B1B95F4BD32CEA481BE",
    "8F14E45FC1EA167A5A36D5DD4BEA2543"
]

Nested Schema : users

Type: array

List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)

Show Source

• Array of: string
  List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)

  Example: ["C5770247BEF54CE0923B7C7CA3B659C8","DBF0480DD86446CE8482BE016726393C"]

{
    "type":"array",
    "description":"List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)",
    "example":[
        "C5770247BEF54CE0923B7C7CA3B659C8",
        "DBF0480DD86446CE8482BE016726393C"
    ],
    "items":{
        "type":"string",
        "description":"List of recipient user identifiers (UUID, 32-character uppercase hexadecimal string)",
        "example":"[\"C5770247BEF54CE0923B7C7CA3B659C8\",\"DBF0480DD86446CE8482BE016726393C\"]"
    }
}

Example:

[
    "C5770247BEF54CE0923B7C7CA3B659C8",
    "DBF0480DD86446CE8482BE016726393C"
]

Examples

Select an example EmailTemplateDto3

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request processed successfully, check the result

400 Response

Error in request, check the request

Body ()

Root Schema : NotificationResponse

Type: object

Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
  Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
• status: string
  Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation."
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Examples

Select an example NotificationResponse

Back to Top