Jump to

• Request
• Response

Use a template to send email to a user

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. 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• emailAddresses: array emailAddresses
• placeHolderImageMap: object placeHolderImageMap
  Additional Properties Allowed: additionalProperties
• placeHolderValueMap: object placeHolderValueMap
  Additional Properties Allowed: additionalProperties
• studyRoleIds: array studyRoleIds
• subject: string
• users: array users

{
    "type":"object",
    "properties":{
        "subject":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "placeHolderValueMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "placeHolderImageMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "studyRoleIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : placeHolderImageMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : placeHolderValueMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : studyRoleIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

400 Response

Bad request.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

500 Response

Internal server error.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top