Jetzt online  

/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.

Parameter

NameTypErforderlichStandardBeschreibung
notificationID int Nein 0 Notification row ID.
getParametersJson string Nein "" Optional validated notification-root context used only while action-button DTOs are generated.
Anfragebeispiel (cURL)
curl --get \
  'https://de.appointmenttrader.com/v1/notification/get_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Parameter: getParametersJson
FeldTypErforderlichBeschreibung
getParametersJsonstring (application/json) NeinJSON-encoded object; empty string uses an empty object.
getParametersJsonobject (dekodiertes JSON) Nein
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Nein
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_detail_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload JaOwned 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].readStatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].isUnreadboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].bodystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].bodyPreviewstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].destinationURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRawNotificationStructuredTags Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTagsarray Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTags[]string Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].textTagsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].textTags[]string Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTagsNotificationDatabaseTags Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTagsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].rawstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].colorstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].linkstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].legacyLinkstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomColorstring Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctionsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].namestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].valuenumber Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formattedValuestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formatKeystring ["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"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].function = "SUM" Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].mediaarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].idinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].widthinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].heightinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].titlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummaryobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.recipientCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.moreCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].hasActionButtonsboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtonsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Namestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].AdditionalTextstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomInfoIconstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTitlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTextstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmButtonTextstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].LoadingTextstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionParameterstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].BackgroundColorstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].TextColorstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Importancestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Clickableboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTagsNotificationDatabaseTags Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.anyOf[0].translationobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.statestring ["done","eligible","none"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.cachedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.contextstring ["chat","notification"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.endpointstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.liveTranslationSourceEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLocaleCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionStatusstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.titlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.bodystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalBodystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].defaultPrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].effectivePrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].typePriorityPreferencestring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].canAdjustPriorityboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].suppressPersistentOverlayboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].plainTextBodystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].hasRecipientsboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1] = false Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
pageSize int Nein 50 Max results to return (clamped to 1..250)
includeRead bool Nein true If false, returns only unread notifications.
offset int Nein 0 Skip this many results (for lazy/infinite pagination).
tags string Nein "" Optional comma-separated list of tag names to filter by, e.g. "Bids,Action Required". Empty = no filter.
readState string Nein "all" all, unread, or read. all preserves includeRead behavior for older callers.
includeSummary bool Nein false If true, MetaInformation includes selected tags and formatted summary functions for the returned rows.
includeActions bool Nein false If true, each row includes executable action-button DTOs.
includeTags bool Nein true If true, each row includes processed display tags.
appointmentID int Nein 0 Optional appointment database tag filter for transaction-scoped history.
getParametersJson string Nein "" Optional validated notification-root context used only while action-button DTOs are generated.
Anfragebeispiel (cURL)
curl --get \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Parameter: getParametersJson
FeldTypErforderlichBeschreibung
getParametersJsonstring (application/json) NeinOptional JSON action-display context. Only overridePayoutMethodDialog=ShowRefundToReviewerDialog is accepted; other input is ignored.
getParametersJsonobject (dekodiertes JSON) Nein
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Nein
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_list_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject JaNewest-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" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Name = "Recent Notifications" Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readStatestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isUnreadboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].titlestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodystring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodyPreviewstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].destinationURLstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRawNotificationStructuredTags Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTagsarray Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTags[]string Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTagsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTags[]string Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTagsNotificationDatabaseTags Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTagsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].rawstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].labelstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].colorstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].linkstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].legacyLinkstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomColorstring Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctionsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].valuenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formattedValuestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formatKeystring ["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"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].function = "SUM" Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].mediaarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].idinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].widthinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].heightinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].titlestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummaryobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.recipientCountinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStatestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.moreCountinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].hasActionButtonsboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtonsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonNamestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].AdditionalTextstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomInfoIconstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTitlestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTextstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmButtonTextstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].LoadingTextstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionParameterstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].BackgroundColorstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].TextColorstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Importancestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Clickableboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTagsNotificationDatabaseTags Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translationobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.statestring ["done","eligible","none"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.cachedboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.contextstring ["chat","notification"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.endpointstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.liveTranslationSourceEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLocaleCodestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionStatusstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.titlestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.bodystring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalBodystring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].defaultPrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].effectivePrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].typePriorityPreferencestring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].canAdjustPriorityboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].suppressPersistentOverlayboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageSizeinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.offsetinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.readStatestring ["all","unread","read"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeReadboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeTagsboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.hasMoreboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTagsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].rawstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].labelstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].colorstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].linkstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].legacyLinkstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomColorstring Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summaryarray Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[]object Nein
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].valuenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formattedValuestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formatKeystring ["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"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].function = "SUM" Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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": []
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
notificationID int Nein 0 Notification row ID from the realtime nudge.
includeChatMessage bool Nein false If true and this is a chat notification, includes the persisted chat message DTO.
Anfragebeispiel (cURL)
curl --get \
  'https://de.appointmenttrader.com/v1/notification/get_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'includeChatMessage={{includeChatMessage}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_preview_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject JaOwned 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.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.typestring ["chat","notification"] Ja
$.oneOf[0].allOf[1].Payload.isUnreadboolean Ja
$.oneOf[0].allOf[1].Payload.readStatestring Ja
$.oneOf[0].allOf[1].Payload.requiresExplicitDismissboolean Ja
$.oneOf[0].allOf[1].Payload.createdDate Ja
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.createdDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.titlestring Ja
$.oneOf[0].allOf[1].Payload.bodyPreviewstring Ja
$.oneOf[0].allOf[1].Payload.destinationURLstring Ja
$.oneOf[0].allOf[1].Payload.isChatMessageboolean Ja
$.oneOf[0].allOf[1].Payload.conversationID Ja
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.chatNamestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].statestring ["done","eligible","none"] Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].cachedboolean Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].context = "chat-name" Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].endpointstring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionStatusstring ["Detected","Pending"] Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionConfidencenull Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].liveTranslationSourceEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].bodystring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalBodystring Ja
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.participantCountinteger Ja
$.oneOf[0].allOf[1].Payload.isUserToUserChatboolean Ja
$.oneOf[0].allOf[1].Payload.senderID Ja
$.oneOf[0].allOf[1].Payload.senderID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.senderID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.senderAlias Ja
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.senderAvatar Ja
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].revisioninteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].customerIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].sellerIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].transactionIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].urlstring Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean NeinTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenUntilinteger | null NeinLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventTypestring ["","sent","submitted","updated","cancelled"] Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].actorUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventTextstring Ja
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.isSystemGeneratedboolean Ja
$.oneOf[0].allOf[1].Payload.hasMediaboolean Ja
$.oneOf[0].allOf[1].Payload.translation Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].statestring ["done","eligible","none"] Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].cachedboolean Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].contextstring ["chat","notification"] Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].endpointstring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].liveTranslationSourceEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLocaleCodestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionStatusstring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].bodystring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalBodystring Ja
$.oneOf[0].allOf[1].Payload.translation.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.notificationTypeSlug Ja
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.notificationTypeLabel Ja
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.defaultPrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.effectivePrioritystring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Ja
$.oneOf[0].allOf[1].Payload.canAdjustPriorityboolean Ja
$.oneOf[0].allOf[1].Payload.suppressPersistentOverlayboolean Ja
$.oneOf[0].allOf[1].Payload.Message Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[0] = false Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].NotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Subjectstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Bodystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].DestinationPagestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Mediaarray Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].idinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].widthinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].heightinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].titlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtonsarray Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonNamestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Namestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].AdditionalTextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomInfoIconstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTitlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmButtonTextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].LoadingTextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionParameterstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].BackgroundColorstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].TextColorstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Importancestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Clickableboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTagsNotificationDatabaseTags Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].revisioninteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].customerIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].sellerIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].transactionIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].urlstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean NeinTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenUntilinteger | null NeinLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventTypestring ["","sent","submitted","updated","cancelled"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].actorUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventTextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Deliveryobject Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.RecipientCountinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipientsarray Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Statestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTimeDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceiptsarray Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedTitlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedBodystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SeenContextstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].Modelstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenboolean Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenUntilinteger | null Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetTypestring ["post","chat_message"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetIdinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerReactionKeystring ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerHasReactedboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].totalCountinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].countsobject Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.thumbs_upinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.heartinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.money_with_wingsinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.laughinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.wowinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.sadinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.angryinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recentarray Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].usernamestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionKeystring ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionEmojistring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsSystemGeneratedboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].type = "reaction" Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetType = "chat_message" Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetNotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actorUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actionstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionKeystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionEmojistring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetPreviewstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetTypestring ["post","chat_message"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetIdinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerReactionKeystring ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerHasReactedboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].totalCountinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].countsobject Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.thumbs_upinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.heartinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.money_with_wingsinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.laughinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.wowinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.sadinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.angryinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recentarray Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[]object Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].usernamestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionKeystring ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionEmojistring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDateDisplaystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].NotificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].Previewstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].HasMediaboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsUnavailableboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsDeletedboolean Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsSystemGeneratedboolean Nein
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].statestring ["done","eligible","none"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].cachedboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].contextstring ["chat","notification"] Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].endpointstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationBodyIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].liveTranslationSourceEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLocaleCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionStatusstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].bodystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalBodystring Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Versioninteger Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsDeletedboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanEditboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanDeleteboolean Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
notificationID int Nein 0 Notification row ID.
Anfragebeispiel (cURL)
curl --get \
  'https://de.appointmenttrader.com/v1/notification/get_recipients' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_recipients_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.recipientsarray Ja
$.oneOf[0].allOf[1].Payload.recipients[]object Nein
$.oneOf[0].allOf[1].Payload.recipients[].UserID Ja
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID Ja
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.recipients[].Usernamestring | null Ja
$.oneOf[0].allOf[1].Payload.recipients[].Statestring Ja
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime Ja
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenboolean Ja
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenUntilinteger | null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_recipients",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "recipients": []
    }
}
Maschinenlesbare Endpunktdokumentation
GET

/v1/notification/get_type_preferences

#
Returns this user's notification type priority overrides. Overrides affect future messages only.
Anfragebeispiel (cURL)
curl --get \
  'https://de.appointmenttrader.com/v1/notification/get_type_preferences' \
  --data-urlencode 'key={{API_KEY}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_type_preferences_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.preferencesarray Ja
$.oneOf[0].allOf[1].Payload.preferences[]object Nein
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeSlugstring Ja
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeLabelstring Ja
$.oneOf[0].allOf[1].Payload.preferences[].typePriorityPreferencestring ["default","normal","priority","high"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_type_preferences",
    "RequestUserAlias": "example-user",
    "Payload": {
        "preferences": []
    }
}
Maschinenlesbare Endpunktdokumentation
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.
Anfragebeispiel (cURL)
curl --get \
  'https://de.appointmenttrader.com/v1/notification/get_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_get_web_push_registration_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject JaRegistration state for the current browser session. API key alone without that session returns hasSession=false.
$.oneOf[0].allOf[1].Payload.registeredboolean Ja
$.oneOf[0].allOf[1].Payload.hasSessionboolean Ja
$.oneOf[0].allOf[1].Payload.clientTypestring Ja
$.oneOf[0].allOf[1].Payload.lastUpdateDate Ja
$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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"
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
actionButtonID int Nein 0 ATNotificationIntelligentTagsActionButtons.ID when available.
notificationID int Nein 0 Notification row ID for rowless legacy actions.
actionButtonName string Nein "" ActionButton class name for rowless legacy actions.
getParametersJson string Nein "" Optional JSON object passed to OnConfirm. Legacy SQL escaping is accepted; malformed supplied JSON is rejected before execution.
globalParametersJson string Nein "" Optional JSON object passed to OnConfirm GlobalParameters. Malformed supplied JSON is rejected before execution.
isWritingRequest bool Nein false Required true to execute.
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Parameter: getParametersJson
FeldTypErforderlichBeschreibung
getParametersJsonstring (application/json) NeinJSON object with action-specific inputs. Fields are used only by the selected action; empty string means no inputs.
getParametersJsonobject (dekodiertes JSON) Nein
getParametersJson.NoShowFeeAmountnumber NeinNo-show fee in USD major units, converted to cents by the action.
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Nein
getParametersJson.ReturnReasonstring Nein
getParametersJson.PaymentFeeAmount Nein
getParametersJson.PaymentFeeAmount.anyOf[0]number Nein
getParametersJson.PaymentFeeAmount.anyOf[1]string NeinCurrency amount; dollar signs/spaces removed and decimal comma supported.
Parameter: globalParametersJson
FeldTypErforderlichBeschreibung
globalParametersJsonstring (application/json) NeinJSON-encoded object; empty string uses an empty object.
globalParametersJsonobject (dekodiertes JSON) Nein
globalParametersJson.RefundUserAccountID Nein
globalParametersJson.RefundUserAccountID.anyOf[0]integer Nein
globalParametersJson.RefundUserAccountID.anyOf[1]string Nein
globalParametersJson.ReturnReasonstring Nein
globalParametersJson.PaymentFeeAmount Nein
globalParametersJson.PaymentFeeAmount.anyOf[0]number Nein
globalParametersJson.PaymentFeeAmount.anyOf[1]string Nein
globalParametersJson.RejectReasonstring Nein
globalParametersJson.sponsorshipContractTermsJsonstring Nein
globalParametersJson.sponsorshipContractTermsJsonobject (dekodiertes JSON) Nein
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent Nein
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent Nein
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent Nein
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsobject Nein
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent Nein
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent Nein
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent Nein
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directResidualPercent Nein
globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent Nein
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent Nein
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent Nein
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent Nein
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[0]number Nein
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[1]string NeinNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Nein
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string NeinNumeric basis points; used only when the corresponding percent field is absent.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_action_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject JaUse an owned actionButtonID, or notificationID plus an advertised actionButtonName. Availability and authorization are rechecked before execution.
$.oneOf[0].allOf[1].Payload.ActionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.RedirectURLstring Ja
$.oneOf[0].allOf[1].Payload.ClientActionstring Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].ChatIDinteger Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Namestring Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Layoutstring Ja
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.NotificationIDinteger Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
isWritingRequest bool Nein 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
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.appointmenttrader.com/v1/notification/set_all_read' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_all_read_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.Markedinteger Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_all_read",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Marked": 0
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
notificationID int Nein 0 Notification row ID.
isWritingRequest bool Nein false Required true to execute.
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.appointmenttrader.com/v1/notification/set_delete' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_delete_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.deleted = true Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_delete",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "deleted": true
    }
}
Maschinenlesbare Endpunktdokumentation
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'

Parameter

NameTypErforderlichStandardBeschreibung
commaSeperatedNotificationIDList string Ja — list of notificationID to be altered
readState string Ja — possible values are Created, Pushed, SentViaEmail or Read
isWritingRequest bool Nein 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
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.appointmenttrader.com/v1/notification/set_readstate' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'commaSeperatedNotificationIDList={{commaSeperatedNotificationIDList}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_readstate_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload = true Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_readstate",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
notificationTypeSlug string Ja — Stable type returned by get_list or get_type_preferences.
priority string Nein "default" default, normal, priority, or high. Normal also prevents persistent overlays.
isWritingRequest bool Nein false Must be true to save; false does not write.
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.appointmenttrader.com/v1/notification/set_type_priority' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationTypeSlug={{notificationTypeSlug}}' \
  --data-urlencode 'priority={{priority}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Parameter: priority
FeldTypErforderlichBeschreibung
prioritystring ["default","normal","priority","high"] Nein
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_type_priority_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.notificationTypeSlugstring Ja
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_type_priority",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationTypeSlug": "synthetic-example",
        "typePriorityPreference": "default"
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
registrationToken string Nein "" Firebase Web Push registration token. Empty clears the current Web Push registration unless permission is granted.
permission string Nein "default" Browser Notification.permission value: granted, denied, or default.
isWritingRequest bool Nein false Required true to execute.
Anfragebeispiel (cURL)
curl --request POST \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$notification_set_web_push_registration_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.registeredboolean Ja
$.oneOf[0].allOf[1].Payload.permissionstring ["granted","denied","default"] Ja
$.oneOf[0].allOf[1].Payload.clientTypestring ["WebPush","Not Specified"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel
{
    "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"
    }
}
Maschinenlesbare Endpunktdokumentation