Online ora  

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

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Parametri: getParametersJson
CampoTipoObbligatorioDescrizione
getParametersJsonstring (application/json) NoJSON-encoded object; empty string uses an empty object.
getParametersJsonobject (JSON decodificato) No
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" No
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_detail_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload SìOwned notification detail including plain text, recipients summary, tags and actions. The legacy serializer can return false if community access is no longer available.
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].readStatestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].isUnreadboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].bodystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].bodyPreviewstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].destinationURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRawNotificationStructuredTags Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTagsarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTags[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].textTagsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].textTags[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTagsNotificationDatabaseTags Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTagsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].rawstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].colorstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].linkstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].legacyLinkstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].selectedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomColorstring No
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctionsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].namestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].valuenumber Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formattedValuestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[1]string Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].function = "SUM" Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].mediaarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].idinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].thumbUrlstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaUrlstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaTypestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].widthinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].heightinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].titlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummaryobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.recipientCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStatestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.moreCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].hasActionButtonsboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtonsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Namestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].AdditionalTextstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomInfoIconstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTitlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTextstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmButtonTextstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].LoadingTextstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionParameterstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].BackgroundColorstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].TextColorstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Importancestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Clickableboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTagsNotificationDatabaseTags Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].translationobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.eligibleboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.statestring ["done","eligible","none"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.cachedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.contextstring ["chat","notification"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.endpointstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[0]number Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.liveTranslationSourceEnabledboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.receiverLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLocaleCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionStatusstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.titlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.bodystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalTitlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalBodystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].defaultPrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].effectivePrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].typePriorityPreferencestring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].canAdjustPriorityboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].suppressPersistentOverlayboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].plainTextBodystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].hasRecipientsboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1] = false Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "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
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Parametri: getParametersJson
CampoTipoObbligatorioDescrizione
getParametersJsonstring (application/json) NoOptional JSON action-display context. Only overridePayoutMethodDialog=ShowRefundToReviewerDialog is accepted; other input is ignored.
getParametersJsonobject (JSON decodificato) No
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" No
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_list_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject SìNewest-first notifications belonging to the acting user. Does not mark them read. Access filtering can omit inaccessible board notifications after pagination. includeTags=false is overridden when tag filters are present; summary is present only with includeSummary=true.
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Name = "Recent Notifications" Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readStatestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isUnreadboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].titlestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodystring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodyPreviewstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].destinationURLstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRawNotificationStructuredTags Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTagsarray No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTags[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTagsarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTags[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTagsNotificationDatabaseTags Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTagsarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].rawstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].labelstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].colorstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].linkstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].legacyLinkstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].selectedboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomColorstring No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctionsarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].valuenumber Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formattedValuestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[1]string Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].function = "SUM" Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].mediaarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].idinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].thumbUrlstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaUrlstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaTypestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].widthinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].heightinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].titlestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummaryobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.recipientCountinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStatestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.moreCountinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].hasActionButtonsboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtonsarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonNamestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].AdditionalTextstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomInfoIconstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTitlestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTextstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmButtonTextstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].LoadingTextstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionParameterstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].BackgroundColorstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].TextColorstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Importancestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Clickableboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTagsNotificationDatabaseTags Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translationobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.eligibleboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.statestring ["done","eligible","none"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.cachedboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.contextstring ["chat","notification"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.endpointstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[0]number Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.liveTranslationSourceEnabledboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.receiverLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLocaleCodestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionStatusstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.titlestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.bodystring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalTitlestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalBodystring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].defaultPrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].effectivePrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].typePriorityPreferencestring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].canAdjustPriorityboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].suppressPersistentOverlayboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageSizeinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.offsetinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.readStatestring ["all","unread","read"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeReadboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeTagsboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.appointmentIDinteger Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.hasMoreboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTagsarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].rawstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].labelstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].colorstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].linkstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].legacyLinkstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].selectedboolean Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomColorstring No
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summaryarray No
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].valuenumber Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formattedValuestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[1]string Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].function = "SUM" Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "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": []
            }
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_preview_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject SìOwned notification preview. Message is present only when includeChatMessage=true and the row is a chat message with a conversation ID; it is false if message access is unavailable.
$.oneOf[0].allOf[1].Payload.notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.typestring ["chat","notification"] Sì
$.oneOf[0].allOf[1].Payload.isUnreadboolean Sì
$.oneOf[0].allOf[1].Payload.readStatestring Sì
$.oneOf[0].allOf[1].Payload.requiresExplicitDismissboolean Sì
$.oneOf[0].allOf[1].Payload.createdDate Sì
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.createdDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.titlestring Sì
$.oneOf[0].allOf[1].Payload.bodyPreviewstring Sì
$.oneOf[0].allOf[1].Payload.destinationURLstring Sì
$.oneOf[0].allOf[1].Payload.isChatMessageboolean Sì
$.oneOf[0].allOf[1].Payload.conversationID Sì
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.chatNamestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].eligibleboolean Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].statestring ["done","eligible","none"] Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].cachedboolean Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].context = "chat-name" Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].endpointstring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionStatusstring ["Detected","Pending"] Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionConfidencenull Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].liveTranslationSourceEnabledboolean Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].bodystring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalTitlestring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalBodystring Sì
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.participantCountinteger Sì
$.oneOf[0].allOf[1].Payload.isUserToUserChatboolean Sì
$.oneOf[0].allOf[1].Payload.senderID Sì
$.oneOf[0].allOf[1].Payload.senderID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.senderID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.senderAlias Sì
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.senderAvatar Sì
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].idinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].revisioninteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].customerIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].sellerIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].bidIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].transactionIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].urlstring Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean NoTrue 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 NoLatest 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"] Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].actorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventTextstring Sì
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.isSystemGeneratedboolean Sì
$.oneOf[0].allOf[1].Payload.hasMediaboolean Sì
$.oneOf[0].allOf[1].Payload.translation Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].eligibleboolean Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].statestring ["done","eligible","none"] Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].cachedboolean Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].contextstring ["chat","notification"] Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].endpointstring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].liveTranslationSourceEnabledboolean Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].receiverLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLocaleCodestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionStatusstring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].bodystring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalTitlestring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalBodystring Sì
$.oneOf[0].allOf[1].Payload.translation.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.notificationTypeSlug Sì
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.notificationTypeLabel Sì
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.defaultPrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.effectivePrioritystring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Sì
$.oneOf[0].allOf[1].Payload.canAdjustPriorityboolean Sì
$.oneOf[0].allOf[1].Payload.suppressPersistentOverlayboolean Sì
$.oneOf[0].allOf[1].Payload.Message No
$.oneOf[0].allOf[1].Payload.Message.anyOf[0] = false No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].NotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Subjectstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Bodystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].DestinationPagestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Mediaarray Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].idinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].thumbUrlstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaUrlstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaTypestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].widthinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].heightinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].titlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtonsarray Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonNamestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Namestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].AdditionalTextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomInfoIconstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTitlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmButtonTextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].LoadingTextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionParameterstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].BackgroundColorstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].TextColorstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Importancestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Clickableboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTagsNotificationDatabaseTags Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].idinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].revisioninteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].customerIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].sellerIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].bidIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].transactionIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].urlstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean NoTrue 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 NoLatest 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"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].actorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventTextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Deliveryobject Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.RecipientCountinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipientsarray Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Statestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTimeDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceiptsarray No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedTitlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedBodystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SeenContextstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].Modelstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenboolean No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenUntilinteger | null No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetTypestring ["post","chat_message"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetIdinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerReactionKeystring ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerHasReactedboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].totalCountinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].countsobject Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.thumbs_upinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.heartinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.money_with_wingsinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.laughinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.wowinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.sadinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.angryinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recentarray Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].userIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].usernamestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionKeystring ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionEmojistring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsSystemGeneratedboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].type = "reaction" Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetType = "chat_message" Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetNotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actionstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionKeystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionEmojistring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetPreviewstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetTypestring ["post","chat_message"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetIdinteger Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerHasReactedboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].totalCountinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].countsobject Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.thumbs_upinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.heartinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.money_with_wingsinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.laughinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.wowinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.sadinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.angryinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recentarray Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[]object No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].userIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].usernamestring Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionEmojistring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDateDisplaystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].NotificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].Previewstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].HasMediaboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsUnavailableboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsDeletedboolean No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsSystemGeneratedboolean No
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].eligibleboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].statestring ["done","eligible","none"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].cachedboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].contextstring ["chat","notification"] Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].endpointstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationBodyIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].liveTranslationSourceEnabledboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageNamestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].receiverLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLocaleCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageCodestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionStatusstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceContentHashstring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].titlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].bodystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalTitlestring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalBodystring Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Versioninteger Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsDeletedboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanEditboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanDeleteboolean Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[1]null Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "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
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
notificationID int No 0 Notification row ID.
Esempio di richiesta (cURL)
curl --get \
  'https://it.appointmenttrader.com/v1/notification/get_recipients' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_recipients_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.recipientsarray Sì
$.oneOf[0].allOf[1].Payload.recipients[]object No
$.oneOf[0].allOf[1].Payload.recipients[].UserID Sì
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.recipients[].Usernamestring | null Sì
$.oneOf[0].allOf[1].Payload.recipients[].Statestring Sì
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime Sì
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenboolean Sì
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenUntilinteger | null Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_recipients",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "recipients": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/notification/get_type_preferences

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_type_preferences_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.preferencesarray Sì
$.oneOf[0].allOf[1].Payload.preferences[]object No
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeSlugstring Sì
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeLabelstring Sì
$.oneOf[0].allOf[1].Payload.preferences[].typePriorityPreferencestring ["default","normal","priority","high"] Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/get_type_preferences",
    "RequestUserAlias": "example-user",
    "Payload": {
        "preferences": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.
Esempio di richiesta (cURL)
curl --get \
  'https://it.appointmenttrader.com/v1/notification/get_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_get_web_push_registration_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject SìRegistration state for the current browser session. API key alone without that session returns hasSession=false.
$.oneOf[0].allOf[1].Payload.registeredboolean Sì
$.oneOf[0].allOf[1].Payload.hasSessionboolean Sì
$.oneOf[0].allOf[1].Payload.clientTypestring Sì
$.oneOf[0].allOf[1].Payload.lastUpdateDate Sì
$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[1]null Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "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"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Esempio di richiesta (cURL)
curl --request POST \
  'https://it.appointmenttrader.com/v1/notification/set_all_read' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_set_all_read_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.Markedinteger Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_all_read",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Marked": 0
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
notificationID int No 0 Notification row ID.
isWritingRequest bool No false Required true to execute.
Esempio di richiesta (cURL)
curl --request POST \
  'https://it.appointmenttrader.com/v1/notification/set_delete' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_set_delete_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.notificationIDinteger Sì
$.oneOf[0].allOf[1].Payload.deleted = true Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_delete",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "deleted": true
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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'

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
commaSeperatedNotificationIDList string Sì — list of notificationID to be altered
readState string Sì — possible values are Created, Pushed, SentViaEmail or Read
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Esempio di richiesta (cURL)
curl --request POST \
  'https://it.appointmenttrader.com/v1/notification/set_readstate' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'commaSeperatedNotificationIDList={{commaSeperatedNotificationIDList}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_set_readstate_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload = true Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_readstate",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Parametri: priority
CampoTipoObbligatorioDescrizione
prioritystring ["default","normal","priority","high"] No
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_set_type_priority_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.notificationTypeSlugstring Sì
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/notification/set_type_priority",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationTypeSlug": "synthetic-example",
        "typePriorityPreference": "default"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$notification_set_web_push_registration_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.registeredboolean Sì
$.oneOf[0].allOf[1].Payload.permissionstring ["granted","denied","default"] Sì
$.oneOf[0].allOf[1].Payload.clientTypestring ["WebPush","Not Specified"] Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta
{
    "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"
    }
}
Documentazione dell’endpoint leggibile dalle macchine