EmailTemplateResource
REST end point to manipulate individual channel-specific notification templates.
The following resources are part of this group:
/notification/channel/email/template
Mount Point: /api/notification/channel/email/template
POST
This end point will add a new notification template to the application.
Request Body
| element: | emailTemplate |
| media types: | application/xml application/json |
this end point expects a single emailTemplate element containing the template to be added
Response Body
| element: | emailTemplate |
| media types: | application/xml application/json |
this end point returns a single emailTemplate element containing the template that was just added
Status Codes
| code | description |
|---|---|
| 400 | The given template was invalid |
| 401 | Authentication required |
| 403 | Authorization required - access forbidden |
/notification/channel/email/template/{identity}
Mount Point: /api/notification/channel/email/template/{identity}
The following operations are supported on this resource:
GET
This end point will return the notification template that has the given identity.
Parameters
| name | description | type | default |
|---|---|---|---|
| identity | the ID of the template to be fetched | path |
Response Body
| element: | emailTemplate |
| media types: | application/xml application/json |
this end point returns a single emailTemplate element
Status Codes
| code | description |
|---|---|
| 404 | Template with the given ID was not found |
| 401 | Authentication required |
| 403 | Authorization required - access forbidden |
DELETE
This end point will delete the notification template with the given identity.
Parameters
| name | description | type | default |
|---|---|---|---|
| identity | the ID of the template to be deleted | path |
Status Codes
| code | description |
|---|---|
| 404 | Template with the given ID was not found |
| 401 | Authentication required |
| 403 | Authorization required - access forbidden |
PUT
This end point will update the notification template with the given identity.
Parameters
| name | description | type | default |
|---|---|---|---|
| identity | the ID of the template to be updated | path |
Request Body
| element: | emailTemplate |
| media types: | */* application/xml |
this end point expects a single emailTemplate element containing the template to be updated
Response Body
| element: | emailTemplate |
| media types: | application/xml application/json |
this end point returns a single emailTemplate element containing the template that was just updated
Status Codes
| code | description |
|---|---|
| 400 | The given template was invalid |
| 404 | Template with the given ID was not found |
| 401 | Authentication required |
| 403 | Authorization required - access forbidden |