notification API reference | AppointmentTrader

Search all endpoints

/v1/notification/

Manages all notification related functions

GET

/v1/notification/get_detail

Returns the full non-chat notification payload for a modal or deep link. Chat notifications are intentionally excluded; those belong to the v2 Messages/chat dock flow.

Parameters

Name	Type	Required	Default	Description
`notificationID`	`int`	`No`	`0`	Notification row ID.
`getParametersJson`	`string`	`No`	`""`	Optional validated notification-root context used only while action-button DTOs are generated.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: getParametersJson

Field	Type	Required	Description
`getParametersJson`	`string (application/json)`	`No`	JSON-encoded object; empty string uses an empty object.
`getParametersJson`	`object (decoded JSON)`	`No`
`getParametersJson.overridePayoutMethodDialog`	`= "ShowRefundToReviewerDialog"`	`No`

Response fields

Field	Type	Required	Description
`$`	`notification_get_detail_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`		`Yes`	Owned notification detail including plain text, recipients summary, tags and actions. The legacy serializer can return false if community access is no longer available.
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].readTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].readState`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].isUnread`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].bodyPreview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].destinationURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw`	`NotificationStructuredTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTags`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTags[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags`	`NotificationDatabaseTags`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].textTags`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].textTags[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags`	`NotificationDatabaseTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].raw`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].color`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].link`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].legacyLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomColor`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].value`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formattedValue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formatKey`	`string ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].function`	`= "SUM"`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].thumbUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].width`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].height`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].media[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.recipientCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientState`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.moreCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].hasActionButtons`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].AdditionalText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomInfoIcon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmButtonText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].LoadingText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomAction`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionParameter`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].BackgroundColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].TextColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Importance`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Clickable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags`	`NotificationDatabaseTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.state`	`string ["done","eligible","none"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.context`	`string ["chat","notification"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.liveTranslationSourceEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLocaleCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].defaultPriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].effectivePriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].typePriorityPreference`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].canAdjustPriority`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].suppressPersistentOverlay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].plainTextBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].hasRecipients`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`= false`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_detail",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "notificationBodyID": 0,
        "createdDate": "synthetic-example",
        "lastUpdateDate": "synthetic-example",
        "readTime": "synthetic-example",
        "readState": "synthetic-example",
        "isUnread": false,
        "title": "synthetic-example",
        "body": "synthetic-example",
        "bodyPreview": "synthetic-example",
        "destinationURL": "synthetic-example",
        "messageGroupID": 0,
        "tagsRaw": [],
        "textTags": [],
        "databaseTags": [],
        "processedTags": [],
        "summaryFunctions": [],
        "media": [],
        "recipientSummary": {
            "recipientCount": 0,
            "firstRecipientUserID": 0,
            "firstRecipientAlias": "synthetic-example",
            "firstRecipientAvatar": "synthetic-example",
            "firstRecipientState": "synthetic-example",
            "firstRecipientStateDate": "synthetic-example",
            "moreCount": 0
        },
        "hasActionButtons": false,
        "actionButtons": [],
        "translation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat",
            "endpoint": "synthetic-example",
            "notificationID": 0,
            "notificationBodyID": 0,
            "chatID": 0,
            "sourceLanguageDetectionConfidence": 0,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "receiverLanguageCode": "synthetic-example",
            "senderLocaleCode": "synthetic-example",
            "senderLanguageCode": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceLanguageDetectionStatus": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "notificationTypeSlug": "synthetic-example",
        "notificationTypeLabel": "synthetic-example",
        "defaultPriority": "default",
        "effectivePriority": "default",
        "typePriorityPreference": "default",
        "canAdjustPriority": false,
        "suppressPersistentOverlay": false,
        "plainTextBody": "synthetic-example",
        "hasRecipients": false
    }
}

Machine-readable endpoint documentation

GET

/v1/notification/get_list

Returns the most recent notifications for the authenticated user. The result is a single list sorted newest-first. Each item carries a readState ('Created' | 'Pushed' | 'SentViaEmail' | 'Read') and an isUnread boolean so consumers can render new vs. read in one pass. Pagination: pass offset to fetch older pages. MetaInformation.hasMore is true only when another page exists beyond the returned items. Calling this endpoint does NOT mark any notifications as read — use notification/set_readstate for that.

Parameters

Name	Type	Required	Default	Description
`pageSize`	`int`	`No`	`50`	Max results to return (clamped to 1..250)
`includeRead`	`bool`	`No`	`true`	If false, returns only unread notifications.
`offset`	`int`	`No`	`0`	Skip this many results (for lazy/infinite pagination).
`tags`	`string`	`No`	`""`	Optional comma-separated list of tag names to filter by, e.g. "Bids,Action Required". Empty = no filter.
`readState`	`string`	`No`	`"all"`	all, unread, or read. all preserves includeRead behavior for older callers.
`includeSummary`	`bool`	`No`	`false`	If true, MetaInformation includes selected tags and formatted summary functions for the returned rows.
`includeActions`	`bool`	`No`	`false`	If true, each row includes executable action-button DTOs.
`includeTags`	`bool`	`No`	`true`	If true, each row includes processed display tags.
`appointmentID`	`int`	`No`	`0`	Optional appointment database tag filter for transaction-scoped history.
`getParametersJson`	`string`	`No`	`""`	Optional validated notification-root context used only while action-button DTOs are generated.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'includeRead={{includeRead}}' \
  --data-urlencode 'offset={{offset}}' \
  --data-urlencode 'tags={{tags}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'includeSummary={{includeSummary}}' \
  --data-urlencode 'includeActions={{includeActions}}' \
  --data-urlencode 'includeTags={{includeTags}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: getParametersJson

Field	Type	Required	Description
`getParametersJson`	`string (application/json)`	`No`	Optional JSON action-display context. Only overridePayoutMethodDialog=ShowRefundToReviewerDialog is accepted; other input is ignored.
`getParametersJson`	`object (decoded JSON)`	`No`
`getParametersJson.overridePayoutMethodDialog`	`= "ShowRefundToReviewerDialog"`	`No`

Response fields

Field	Type	Required	Description
`$`	`notification_get_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`	Newest-first notifications belonging to the acting user. Does not mark them read. Access filtering can omit inaccessible board notifications after pagination. includeTags=false is overridden when tag filters are present; summary is present only with includeSummary=true.
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`= "Recent Notifications"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readState`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isUnread`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodyPreview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].destinationURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw`	`NotificationStructuredTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTags`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTags[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags`	`NotificationDatabaseTags`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTags`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTags[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags`	`NotificationDatabaseTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].raw`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].color`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].link`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].legacyLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomColor`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].value`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formattedValue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formatKey`	`string ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].function`	`= "SUM"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].thumbUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].width`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].height`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.recipientCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientState`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.moreCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].hasActionButtons`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].AdditionalText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomInfoIcon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmButtonText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].LoadingText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomAction`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionParameter`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].BackgroundColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].TextColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Importance`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Clickable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags`	`NotificationDatabaseTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.state`	`string ["done","eligible","none"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.context`	`string ["chat","notification"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.liveTranslationSourceEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLocaleCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].defaultPriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].effectivePriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].typePriorityPreference`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].canAdjustPriority`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].suppressPersistentOverlay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageSize`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.offset`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.readState`	`string ["all","unread","read"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeRead`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeTags`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.hasMore`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].raw`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].color`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].link`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].legacyLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[1]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[2]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[0]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomColor`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].value`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formattedValue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formatKey`	`string ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].function`	`= "SUM"`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "Recent Notifications",
            "KeyValueList": [],
            "KeyValueFieldList": [],
            "MetaInformation": {
                "pageSize": 0,
                "offset": 0,
                "readState": "all",
                "includeRead": false,
                "includeTags": false,
                "appointmentID": 0,
                "hasMore": false,
                "selectedTags": []
            }
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/notification/get_preview

Returns a compact, authenticated preview for one notification. Used by the ATV2 realtime preview banner after the WebSocket nudge tells the browser which notification row changed. The socket carries only the notification ID; this endpoint re-reads the row under the acting user so notification and chat text never travels on the unauthenticated WebSocket channel. Calling this endpoint does NOT mark the notification as read. requiresExplicitDismiss is true for Overlay Notification or Action Required tags unless the creation-time override was Normal; clients keep those previews until explicitly dismissed or opened.

Parameters

Name	Type	Required	Default	Description
`notificationID`	`int`	`No`	`0`	Notification row ID from the realtime nudge.
`includeChatMessage`	`bool`	`No`	`false`	If true and this is a chat notification, includes the persisted chat message DTO.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'includeChatMessage={{includeChatMessage}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`notification_get_preview_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`	Owned notification preview. Message is present only when includeChatMessage=true and the row is a chat message with a conversation ID; it is false if message access is unavailable.
`$.oneOf[0].allOf[1].Payload.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.type`	`string ["chat","notification"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.isUnread`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.readState`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.requiresExplicitDismiss`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.createdDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bodyPreview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.destinationURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.isChatMessage`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.conversationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.conversationID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.conversationID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation`		`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].state`	`string ["done","eligible","none"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].context`	`= "chat-name"`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionStatus`	`string ["Detected","Pending"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionConfidence`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].liveTranslationSourceEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.participantCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.isUserToUserChat`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderID`		`Yes`
`$.oneOf[0].allOf[1].Payload.senderID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderAvatar`		`Yes`
`$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey`		`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].revision`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].customerID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].sellerID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].status`	`string ["sent","in_progress","submitted","cancelled"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventType`	`string ["","sent","submitted","updated","cancelled"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].actorUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.isSystemGenerated`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.hasMedia`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation`		`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].state`	`string ["done","eligible","none"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].context`	`string ["chat","notification"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence`		`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].liveTranslationSourceEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLocaleCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.translation.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeSlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeLabel`		`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.defaultPriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.effectivePriority`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.typePriorityPreference`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.canAdjustPriority`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.suppressPersistentOverlay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message`		`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[0]`	`= false`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].NotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Subject`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].DestinationPage`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].thumbUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].width`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].height`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].AdditionalText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomInfoIcon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmButtonText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].LoadingText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomAction`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionParameter`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].BackgroundColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].TextColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Importance`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Clickable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags`	`NotificationDatabaseTags`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1]..anyOf[5].`	`NotificationTagValue`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].revision`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].customerID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].sellerID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].status`	`string ["sent","in_progress","submitted","cancelled"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventType`	`string ["","sent","submitted","updated","cancelled"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].actorUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.RecipientCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].State`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTimeDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SeenContext`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].Model`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHidden`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenUntil`	`integer \| null`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetType`	`string ["post","chat_message"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetId`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerReactionKey`	`string ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerHasReacted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].totalCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.thumbs_up`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.heart`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.money_with_wings`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.laugh`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.wow`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.sad`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.angry`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].userID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].username`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionKey`	`string ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionEmoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsSystemGenerated`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].type`	`= "reaction"`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetType`	`= "chat_message"`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetNotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actorUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].action`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionKey`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionEmoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetPreview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetType`	`string ["post","chat_message"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetId`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerReactionKey`	`string ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerHasReacted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].totalCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.thumbs_up`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.heart`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.money_with_wings`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.laugh`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.wow`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.sad`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.angry`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].userID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].username`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionKey`	`string ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionEmoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDateDisplay`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].NotificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].Preview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].HasMedia`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsUnavailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsDeleted`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsSystemGenerated`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].state`	`string ["done","eligible","none"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].context`	`string ["chat","notification"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationBodyID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].liveTranslationSourceEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLocaleCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Version`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsDeleted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanEdit`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanDelete`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline`		`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "notificationBodyID": 0,
        "type": "chat",
        "isUnread": false,
        "readState": "synthetic-example",
        "requiresExplicitDismiss": false,
        "createdDate": "synthetic-example",
        "createdDateDisplay": "synthetic-example",
        "title": "synthetic-example",
        "bodyPreview": "synthetic-example",
        "destinationURL": "synthetic-example",
        "isChatMessage": false,
        "conversationID": 0,
        "chatName": "synthetic-example",
        "chatNameTranslation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat-name",
            "endpoint": "synthetic-example",
            "chatID": 0,
            "sourceLanguageDetectionStatus": "Detected",
            "sourceLanguageDetectionConfidence": null,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "participantCount": 0,
        "isUserToUserChat": false,
        "senderID": 0,
        "senderAlias": "synthetic-example",
        "senderAvatar": "synthetic-example",
        "CustomerSurvey": {
            "id": 0,
            "revision": 0,
            "customerID": 0,
            "sellerID": 0,
            "chatID": 0,
            "bidID": 0,
            "transactionID": 0,
            "title": "synthetic-example",
            "status": "sent",
            "submittedDate": "synthetic-example",
            "url": "synthetic-example",
            "eventType": "",
            "actorUserID": 0,
            "eventText": "synthetic-example"
        },
        "isSystemGenerated": false,
        "hasMedia": false,
        "translation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat",
            "endpoint": "synthetic-example",
            "notificationID": 0,
            "notificationBodyID": 0,
            "chatID": 0,
            "sourceLanguageDetectionConfidence": 0,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "receiverLanguageCode": "synthetic-example",
            "senderLocaleCode": "synthetic-example",
            "senderLanguageCode": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceLanguageDetectionStatus": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "notificationTypeSlug": "synthetic-example",
        "notificationTypeLabel": "synthetic-example",
        "defaultPriority": "default",
        "effectivePriority": "default",
        "typePriorityPreference": "default",
        "canAdjustPriority": false,
        "suppressPersistentOverlay": false
    }
}

Machine-readable endpoint documentation

GET

/v1/notification/get_recipients

Returns recipient/read-state information for one non-chat notification. A protected bid customer has null identity fields and identityHidden=true until the saved race closing time.

Parameters

Name	Type	Required	Default	Description
`notificationID`	`int`	`No`	`0`	Notification row ID.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_recipients' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_get_recipients_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.recipients[].UserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].Username`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].State`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ReadTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].identityHidden`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenUntil`	`integer \| null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_recipients",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "recipients": []
    }
}

Machine-readable endpoint documentation

GET

/v1/notification/get_type_preferences

Returns this user's notification type priority overrides. Overrides affect future messages only.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_type_preferences' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_get_type_preferences_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.preferences`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.preferences[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeSlug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.preferences[].typePriorityPreference`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_type_preferences",
    "RequestUserAlias": "example-user",
    "Payload": {
        "preferences": []
    }
}

Machine-readable endpoint documentation

GET

/v1/notification/get_web_push_registration

Returns whether the current browser session already has a Web Push token. Android PWA clients call this on startup after browser notification permission has already been granted. It lets the app hide the notification enablement banner without exposing the Firebase token.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/notification/get_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`notification_get_web_push_registration_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`	Registration state for the current browser session. API key alone without that session returns hasSession=false.
`$.oneOf[0].allOf[1].Payload.registered`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.hasSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastUpdateDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_web_push_registration",
    "RequestUserAlias": "example-user",
    "Payload": {
        "registered": false,
        "hasSession": false,
        "clientType": "synthetic-example",
        "lastUpdateDate": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/notification/set_action

Executes a non-chat notification action button owned by the caller. Preferred clients send actionButtonID from get_detail/get_list. For older notification actions that never created an action row, send notificationID plus actionButtonName; the server re-reads the row and validates the action before execution.

Parameters

Name	Type	Required	Default	Description
`actionButtonID`	`int`	`No`	`0`	ATNotificationIntelligentTagsActionButtons.ID when available.
`notificationID`	`int`	`No`	`0`	Notification row ID for rowless legacy actions.
`actionButtonName`	`string`	`No`	`""`	ActionButton class name for rowless legacy actions.
`getParametersJson`	`string`	`No`	`""`	Optional JSON object passed to OnConfirm. Legacy SQL escaping is accepted; malformed supplied JSON is rejected before execution.
`globalParametersJson`	`string`	`No`	`""`	Optional JSON object passed to OnConfirm GlobalParameters. Malformed supplied JSON is rejected before execution.
`isWritingRequest`	`bool`	`No`	`false`	Required true to execute.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_action' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'actionButtonID={{actionButtonID}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'actionButtonName={{actionButtonName}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}' \
  --data-urlencode 'globalParametersJson={{globalParametersJson}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: getParametersJson

Field	Type	Required	Description
`getParametersJson`	`string (application/json)`	`No`	JSON object with action-specific inputs. Fields are used only by the selected action; empty string means no inputs.
`getParametersJson`	`object (decoded JSON)`	`No`
`getParametersJson.NoShowFeeAmount`	`number`	`No`	No-show fee in USD major units, converted to cents by the action.
`getParametersJson.overridePayoutMethodDialog`	`= "ShowRefundToReviewerDialog"`	`No`
`getParametersJson.ReturnReason`	`string`	`No`
`getParametersJson.PaymentFeeAmount`		`No`
`getParametersJson.PaymentFeeAmount.anyOf[0]`	`number`	`No`
`getParametersJson.PaymentFeeAmount.anyOf[1]`	`string`	`No`	Currency amount; dollar signs/spaces removed and decimal comma supported.

Parameters: globalParametersJson

Field	Type	Required	Description
`globalParametersJson`	`string (application/json)`	`No`	JSON-encoded object; empty string uses an empty object.
`globalParametersJson`	`object (decoded JSON)`	`No`
`globalParametersJson.RefundUserAccountID`		`No`
`globalParametersJson.RefundUserAccountID.anyOf[0]`	`integer`	`No`
`globalParametersJson.RefundUserAccountID.anyOf[1]`	`string`	`No`
`globalParametersJson.ReturnReason`	`string`	`No`
`globalParametersJson.PaymentFeeAmount`		`No`
`globalParametersJson.PaymentFeeAmount.anyOf[0]`	`number`	`No`
`globalParametersJson.PaymentFeeAmount.anyOf[1]`	`string`	`No`
`globalParametersJson.RejectReason`	`string`	`No`
`globalParametersJson.sponsorshipContractTermsJson`	`string`	`No`
`globalParametersJson.sponsorshipContractTermsJson`	`object (decoded JSON)`	`No`
`globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.directResidualPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent`		`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms`	`object`	`No`
`globalParametersJson.sponsorshipContractTerms.directFirstYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.directSecondYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.directThirdYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.directResidualPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.
`globalParametersJson.sponsorshipContractTerms.indirectResidualPercent`		`No`
`globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[0]`	`number`	`No`
`globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[1]`	`string`	`No`	Numeric percentage, localized decimal comma accepted.
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints`		`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]`	`integer`	`No`
`globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]`	`string`	`No`	Numeric basis points; used only when the corresponding percent field is absent.

Response fields

Field	Type	Required	Description
`$`	`notification_set_action_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`	Use an owned actionButtonID, or notificationID plus an advertised actionButtonName. Availability and authorization are rechecked before execution.
`$.oneOf[0].allOf[1].Payload.ActionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.RedirectURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ClientAction`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock`		`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].ChatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Layout`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.NotificationID`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_action",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ActionButtonID": 0,
        "RedirectURL": "synthetic-example",
        "ClientAction": "synthetic-example",
        "OpenChatDock": {
            "ChatID": 0,
            "Name": "synthetic-example",
            "Layout": "synthetic-example"
        },
        "NotificationID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/notification/set_all_read

Marks every unread non-chat notification for the authenticated user as read. The native v2 notifications dashboard calls this once on open so the page behaves like an inbox visit rather than only marking the first lazy-loaded page. Chat notifications are intentionally excluded; the v2 chat dock owns chat-read timing so merely opening the notifications dashboard does not clear message unread state.

Parameters

Name	Type	Required	Default	Description
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_all_read' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_set_all_read_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Marked`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_all_read",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Marked": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/notification/set_delete

Soft-deletes one notification owned by the authenticated user. The notification row remains in ATNotifications for audit/history, but DeletedDate is set so native v2 notification lists and unread counts no longer show it.

Parameters

Name	Type	Required	Default	Description
`notificationID`	`int`	`No`	`0`	Notification row ID.
`isWritingRequest`	`bool`	`No`	`false`	Required true to execute.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_delete' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_set_delete_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.deleted`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_delete",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "deleted": true
    }
}

Machine-readable endpoint documentation

POST

/v1/notification/set_readstate

Changes the visibility of the notifications in the ID list In the portal private listings appear in the private section and public in 'Publicly traded listings'

Parameters

Name	Type	Required	Default	Description
`commaSeperatedNotificationIDList`	`string`	`Yes`	`—`	list of notificationID to be altered
`readState`	`string`	`Yes`	`—`	possible values are Created, Pushed, SentViaEmail or Read
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_readstate' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'commaSeperatedNotificationIDList={{commaSeperatedNotificationIDList}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_set_readstate_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_readstate",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/notification/set_type_priority

Sets the acting user's priority for future notifications of a registered type. Default removes the override. Existing notifications and pending deliveries retain their creation-time priority.

Parameters

Name	Type	Required	Default	Description
`notificationTypeSlug`	`string`	`Yes`	`—`	Stable type returned by get_list or get_type_preferences.
`priority`	`string`	`No`	`"default"`	default, normal, priority, or high. Normal also prevents persistent overlays.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to save; false does not write.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_type_priority' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationTypeSlug={{notificationTypeSlug}}' \
  --data-urlencode 'priority={{priority}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: priority

Field	Type	Required	Description
`priority`	`string ["default","normal","priority","high"]`	`No`

Response fields

Field	Type	Required
`$`	`notification_set_type_priority_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.notificationTypeSlug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.typePriorityPreference`	`string ["default","normal","priority","high"]`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_type_priority",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationTypeSlug": "synthetic-example",
        "typePriorityPreference": "default"
    }
}

Machine-readable endpoint documentation

POST

/v1/notification/set_web_push_registration

Registers or clears the current browser session's Firebase Web Push token. Android PWA clients call this after the user grants browser notification permission. The token is stored on the current ATUserSession so the existing notification push job can fan out to it alongside native app device tokens.

Parameters

Name	Type	Required	Default	Description
`registrationToken`	`string`	`No`	`""`	Firebase Web Push registration token. Empty clears the current Web Push registration unless permission is granted.
`permission`	`string`	`No`	`"default"`	Browser Notification.permission value: granted, denied, or default.
`isWritingRequest`	`bool`	`No`	`false`	Required true to execute.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/notification/set_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'registrationToken={{registrationToken}}' \
  --data-urlencode 'permission={{permission}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`notification_set_web_push_registration_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.registered`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.permission`	`string ["granted","denied","default"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.clientType`	`string ["WebPush","Not Specified"]`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_web_push_registration",
    "RequestUserAlias": "example-user",
    "Payload": {
        "registered": false,
        "permission": "granted",
        "clientType": "WebPush"
    }
}

Machine-readable endpoint documentation