Template

The Template API allows you to list, create, update, search by ID, and delete notification templates.

Refer to the Template API calls below:

• List templates
• Create template
• Get template by ID
• Update template by ID
• Delete template by ID

List templates

Endpoints

GET notificationsvc/api/v1/template

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_count	Integer	Number of templates. Default is 10.	Required
_offset	Integer	Position in list of templates to begin listing	Required
_locale	String	Template area	Optional
_name	String	Name of subscription	Required
_namespace	String	Project namespace	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _offset?: integer  _pageSize?: integer  _total?: integer  _list: {    _id?: string    _namespaces?: string[]    _createdAt?: string    _updatedAt?: string    _version?: integer    _name: string    _description?: string    _locale: string    _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]    _format: enum[VELOCITY]    _email: {      _subject?: string      _body?: string    }  }[]}

Create template

Endpoints

POST notificationsvc/api/v1/template

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

{  _description?: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _format: enum[VELOCITY]  _email: {    _subject?: string    _body?: string  }  _namespaces?: string[]  _name: string  _locale: string}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _createdAt?: string  _updatedAt?: string  _version?: integer  _name: string  _description?: string  _locale: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _format: enum[VELOCITY]  _email: {    _subject?: string    _body?: string  }}

Get template by ID

Endpoints

GET notificationsvc/api/v1/template/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _createdAt?: string  _updatedAt?: string  _version?: integer  _name: string  _description?: string  _locale: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _format: enum[VELOCITY]  _email: {    _subject?: string    _body?: string  }}

Update template by ID

Endpoints

PUT notificationsvc/api/v1/template/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_version	Integer	Version of group	Optional

Request body example

{  _description?: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _format: enum[VELOCITY]  _email: {    _subject?: string    _body?: string  }}

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response

{  _id?: string  _namespaces?: string[]  _createdAt?: string  _updatedAt?: string  _version?: integer  _name: string  _description?: string  _locale: string  _transport: enum[EMAIL, PUSH, WEBSOCKET, WEBHOOK]  _format: enum[VELOCITY]  _email: {    _subject?: string    _body?: string  }}

Delete template by ID

Endpoints

DELETE notificationsvc/api/v1/template/{id}

Request

Request body

Parameter	Type	Description	Required
_nsFilter	String	Event filter to apply	Optional
_version	String	Version to apply

Request body example

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response