RESTful API
Default

Email Templates

Get notifications

Returns a set of data items of type notifications.

Copy GET /api/default/notifications
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "Subject": "sample string 1",
    "ModuleName": "sample string 2",
    "ResolveKey": "sample string 3",
    "BodyHtml": "sample string 4",
    "AccountName": "sample string 5",
    "AdditionalMessageData": "sample string 6",
    "TemplateSenderEmailAddress": "sample string 7",
    "TemplateSenderName": "sample string 8",
    "SystemMessage": "sample string 9",
    "SystemUrl": "sample string 10",
    "PlainTextVersion": "sample string 11"
  },
  {
    "Subject": "sample string 1",
    "ModuleName": "sample string 2",
    "ResolveKey": "sample string 3",
    "BodyHtml": "sample string 4",
    "AccountName": "sample string 5",
    "AdditionalMessageData": "sample string 6",
    "TemplateSenderEmailAddress": "sample string 7",
    "TemplateSenderName": "sample string 8",
    "SystemMessage": "sample string 9",
    "SystemUrl": "sample string 10",
    "PlainTextVersion": "sample string 11"
  }
]

Get notifications by key

Gets notifications item by id.

Copy GET /api/default/notifications({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "Subject": "sample string 1",
  "ModuleName": "sample string 2",
  "ResolveKey": "sample string 3",
  "BodyHtml": "sample string 4",
  "AccountName": "sample string 5",
  "AdditionalMessageData": "sample string 6",
  "TemplateSenderEmailAddress": "sample string 7",
  "TemplateSenderName": "sample string 8",
  "SystemMessage": "sample string 9",
  "SystemUrl": "sample string 10",
  "PlainTextVersion": "sample string 11"
}

Get property

Gets Id property from notifications item.

Copy GET /api/default/notifications({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Id

System.Guid

Read only: False

Resource Format

Response Formats
Copy
application/json
{
  "Id": "83f714af-99a3-44c5-b325-b8c2bcf882f5"
}

Post notifications

Creates a notifications item.

Copy POST /api/default/notifications
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Request Formats
Copy
application/json
{
  "Subject": "sample string 1",
  "ModuleName": "sample string 2",
  "ResolveKey": "sample string 3",
  "BodyHtml": "sample string 4",
  "AccountName": "sample string 5",
  "AdditionalMessageData": "sample string 6",
  "TemplateSenderEmailAddress": "sample string 7",
  "TemplateSenderName": "sample string 8",
  "SystemMessage": "sample string 9",
  "SystemUrl": "sample string 10",
  "PlainTextVersion": "sample string 11"
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "Subject": "sample string 1",
  "ModuleName": "sample string 2",
  "ResolveKey": "sample string 3",
  "BodyHtml": "sample string 4",
  "AccountName": "sample string 5",
  "AdditionalMessageData": "sample string 6",
  "TemplateSenderEmailAddress": "sample string 7",
  "TemplateSenderName": "sample string 8",
  "SystemMessage": "sample string 9",
  "SystemUrl": "sample string 10",
  "PlainTextVersion": "sample string 11"
}

Patch notifications by key

Partial update for notifications item.

Copy PATCH /api/default/notifications({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Request Formats
Copy
application/json
{
  "Subject": "sample string 1",
  "ModuleName": "sample string 2",
  "ResolveKey": "sample string 3",
  "BodyHtml": "sample string 4",
  "AccountName": "sample string 5",
  "AdditionalMessageData": "sample string 6",
  "TemplateSenderEmailAddress": "sample string 7",
  "TemplateSenderName": "sample string 8",
  "SystemMessage": "sample string 9",
  "SystemUrl": "sample string 10",
  "PlainTextVersion": "sample string 11"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put notifications by key

Full update for notifications item.

Copy PUT /api/default/notifications({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
Subject

System.String

Read only: False
Selected by default: True

ModuleName

System.String

Read only: False
Selected by default: True

ResolveKey

System.String

Read only: False
Selected by default: True

BodyHtml

System.String

Read only: False
Selected by default: True

AccountName

System.String

Read only: False
Selected by default: True

AdditionalMessageData

System.String

Read only: False
Selected by default: True

TemplateSenderEmailAddress

System.String

Read only: False
Selected by default: True

TemplateSenderName

System.String

Read only: False
Selected by default: True

SystemMessage

System.String

Read only: False
Selected by default: True

SystemUrl

System.String

Read only: False
Selected by default: True

PlainTextVersion

System.String

Read only: False
Selected by default: True

Request Formats
Copy
application/json
{
  "Subject": "sample string 1",
  "ModuleName": "sample string 2",
  "ResolveKey": "sample string 3",
  "BodyHtml": "sample string 4",
  "AccountName": "sample string 5",
  "AdditionalMessageData": "sample string 6",
  "TemplateSenderEmailAddress": "sample string 7",
  "TemplateSenderName": "sample string 8",
  "SystemMessage": "sample string 9",
  "SystemUrl": "sample string 10",
  "PlainTextVersion": "sample string 11"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete notifications by key

Deletes a notifications item by Id.

Copy DELETE /api/default/notifications({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.