IBM Cloud API Docs

Introduction

Last updated: 2018-06-12

This API is for managing your custom notification templates. You can create a custom template for a notification to override the built-in template.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

listTemplates

List all custom notification templates

GET /notificationTemplates/v1

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,text/plain]

Response

Response Body

TemplateSummary[]

Status Code

  • 200

    Summary of custom notification templates

  • 401

    User credentials are not authenticated for this request

  • 403

    User does not have privileges for this request

  • 500

    There was an internal error processing the request

Example responses
  • [
  {
    "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"
  }
]

createTemplate

Creates a custom notification template

POST /notificationTemplates/v1

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,text/plain]

Request Body

Required*
TemplatePayload

Custom notification template payload

Response

Response Body

Template

Status Code

  • 201

    A single custom notification template

  • 400

    Invalid request

  • 401

    User credentials are not authenticated for this request

  • 403

    User does not have privileges for this request

  • 500

    There was an internal error processing the request

Example responses
  • {
  "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

  • Accept
    string

    Allowable values: [application/json,text/plain]

Path Parameters

  • name
    Required*
    string

    Custom notification template name

Request Body

Required*
TemplatePayload

Custom notification template payload

Response

Response Body

Template

Status Code

  • 200

    A single custom notification template after update

  • 400

    Invalid request

  • 401

    User credentials are not authenticated for this request

  • 403

    User does not have privileges for this request

  • 404

    The requested object was not found

  • 500

    There was an internal error processing the request

No Sample Response

This method does not specify any sample responses.

getTemplate

Get a custom notification template by name.

GET /notificationTemplates/v1/{name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,text/plain]

Path Parameters

  • name
    Required*
    string

    Custom notification template name

Response

Response Body

Template

Status Code

  • 200

    A single custom notification template

  • 401

    User credentials are not authenticated for this request

  • 403

    User does not have privileges for this request

  • 404

    The requested object was not found

  • 500

    There was an internal error processing the request

Example responses
  • {
  "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"
}

deleteTemplate

Delete a custom notification template

DELETE /notificationTemplates/v1/{name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,text/plain]

Path Parameters

  • name
    Required*
    string

    Custom notification template name

Response

Status Code

  • 204

    Successful request

  • 401

    User credentials are not authenticated for this request

  • 403

    User does not have privileges for this request

  • 404

    The requested object was not found

  • 500

    There was an internal error processing the request

No Sample Response

This method does not specify any sample responses.