Skip to main content

Create Notification Template

POST 

/notification-templates

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This creates a template for your site.

You can also use this endpoint to update a template. First, copy the response body from the get notification template endpoint for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.

Request

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Body

required

    key stringrequired

    The key of the template

    name string

    The name of the Task Manager Subscription

    medium stringrequired

    Possible values: [EMAIL, PHONE, SMS, SLACK, TEAMS]

    The message medium. More mediums may be added in the future.

    locale stringrequired

    The locale for the message text, a BCP 47 language tag.

    subject string

    The subject line in the template

    header stringnullabledeprecated

    The header value is now located within the body field. If included with non-null values, will result in a 400.

    body string

    The body in the template

    footer stringnullabledeprecated

    The footer value is now located within the body field. If included with non-null values, will result in a 400.

    from string

    The "From:" address in the template

    replyTo string

    The "Reply To" line in the template

    description string

    The description in the template

    id string

    This is auto-generated.

    created date-time

    The time when this template is created. This is auto-generated.

    modified date-time

    The time when this template was last modified. This is auto-generated.

    slackTemplate stringnullable
    teamsTemplate stringnullable

Responses

A template object for your site

Schema

    key stringrequired

    The key of the template

    name string

    The name of the Task Manager Subscription

    medium stringrequired

    Possible values: [EMAIL, PHONE, SMS, SLACK, TEAMS]

    The message medium. More mediums may be added in the future.

    locale stringrequired

    The locale for the message text, a BCP 47 language tag.

    subject string

    The subject line in the template

    header stringnullabledeprecated

    The header value is now located within the body field. If included with non-null values, will result in a 400.

    body string

    The body in the template

    footer stringnullabledeprecated

    The footer value is now located within the body field. If included with non-null values, will result in a 400.

    from string

    The "From:" address in the template

    replyTo string

    The "Reply To" line in the template

    description string

    The description in the template

    id string

    This is auto-generated.

    created date-time

    The time when this template is created. This is auto-generated.

    modified date-time

    The time when this template was last modified. This is auto-generated.

    slackTemplate stringnullable
    teamsTemplate stringnullable
Loading...