get notification message
GET https://api.suger.cloud/org/{orgId}/notificationMessage/{notificationMessageId}
Get the notification message of the organization & notification message ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
notificationMessageId | path | string | yes | Notification Message ID |
Responses
200 — OK
Content-Type: application/json · Schema: orm.NotificationMessage
orm.NotificationMessage fields:
| Field | Type | Required | Description |
|---|---|---|---|
creationTime | string | no | CreationTime holds the value of the "creation_time" field. |
id | string | no | ID of the ent. |
info | NotificationMessageInfo | no | |
organizationID | string | no | OrganizationID holds the value of the "organization_id" field. |
recipient | string | no | supports multiple recipients as a comma-separated string |
type | notificationmessage.Type | no |
NotificationMessageInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
action | NotificationEventAction | no | |
bccRecipients | array<string> | no | |
ccRecipients | array<string> | no | |
customFields | object | no | All other fields |
htmlContent | string | no | The HTML content of the email. |
standardFields | object | no | The standard fields to render the email content. |
subject | string | no | |
textContent | string | no | The text content of the email in case the recipient's email client does not support HTML. |
400 — Bad request error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.