Methods
Response
Unique name of the custom notification template.
Possible values: [
template
]Possible values: length ≥ 1
True if this custom notification template is enabled. Default is false.
URI to fetch this custom notification template.
Description of the custom notification template.
Possible values: length ≥ 0
Last time the custom notification template was updated.
User that last updated the custom notification template.
Possible values: length ≥ 1
Status Code
Summary of custom notification templates
User credentials are not authenticated for this request
User does not have privileges for this request
There was an internal error processing the request
[ { "name": "template", "description": "This is a sample custom notification template.", "enabled": true, "templateURI": "https://testhost.com/api/notificationTemplates/v1/template", "lastUpdated": "2017-11-02T18:03:44.614Z", "lastUpdatedBy": "johndoe@yourco.us.com" } ]
Request
Custom Headers
Allowable values: [
application/json
,text/plain
]
Custom notification template payload
Unique name of the custom notification template.
Allowable values: [
template
]Possible values: length ≥ 1
Set of all available notification overrides possible for one template. At least one property must be specified.
Description of the custom notification template.
Possible values: length ≥ 0
Is this custom notification template enabled for runtime use? Default is false.
Response
Unique name of the custom notification template.
Possible values: [
template
]Possible values: length ≥ 1
Set of all available notification overrides possible for one template. At least one property must be specified.
Description of the custom notification template.
Possible values: length ≥ 0
Is this custom notification template enabled for runtime use? Default is false.
The time when this notification template was last updated.
The name of the user who last modified this notification template. Set to creator if this policy has never been updated
Possible values: length ≥ 1
Status Code
A single custom notification template
Invalid request
User credentials are not authenticated for this request
User does not have privileges for this request
There was an internal error processing the request
{ "name": "template", "description": "This is a sample custom notification template.", "enabled": true, "overrides": { "email": { "subject": "Sample subject", "body": "Sample email body with substitution {{Where}}" } }, "lastUpdated": "2017-11-02T18:03:44.614Z", "lastUpdatedBy": "johndoe@yourco.us.com" }
replaceTemplate
Replace the custom notification template with the template payload provided.
PUT /notificationTemplates/v1/{name}
Request
Custom Headers
Allowable values: [
application/json
,text/plain
]
Path Parameters
Custom notification template name
Allowable values: [
template
]
Custom notification template payload
Unique name of the custom notification template.
Allowable values: [
template
]Possible values: length ≥ 1
Set of all available notification overrides possible for one template. At least one property must be specified.
Description of the custom notification template.
Possible values: length ≥ 0
Is this custom notification template enabled for runtime use? Default is false.
Response
Unique name of the custom notification template.
Possible values: [
template
]Possible values: length ≥ 1
Set of all available notification overrides possible for one template. At least one property must be specified.
Description of the custom notification template.
Possible values: length ≥ 0
Is this custom notification template enabled for runtime use? Default is false.
The time when this notification template was last updated.
The name of the user who last modified this notification template. Set to creator if this policy has never been updated
Possible values: length ≥ 1
Status Code
A single custom notification template after update
Invalid request
User credentials are not authenticated for this request
User does not have privileges for this request
The requested object was not found
There was an internal error processing the request
No Sample Response
Request
Custom Headers
Allowable values: [
application/json
,text/plain
]
Path Parameters
Custom notification template name
Allowable values: [
template
]
Response
Unique name of the custom notification template.
Possible values: [
template
]Possible values: length ≥ 1
Set of all available notification overrides possible for one template. At least one property must be specified.
Description of the custom notification template.
Possible values: length ≥ 0
Is this custom notification template enabled for runtime use? Default is false.
The time when this notification template was last updated.
The name of the user who last modified this notification template. Set to creator if this policy has never been updated
Possible values: length ≥ 1
Status Code
A single custom notification template
User credentials are not authenticated for this request
User does not have privileges for this request
The requested object was not found
There was an internal error processing the request
{ "name": "template", "description": "This is a sample custom notification template.", "enabled": true, "overrides": { "email": { "subject": "Sample subject", "body": "Sample email body with substitution {{Where}}" } }, "lastUpdated": "2017-11-02T18:03:44.614Z", "lastUpdatedBy": "johndoe@yourco.us.com" }