Show Notification - Placewise API

Request

Path Params

integer

required

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

notification

object (UserNotification)

required

integer <uint64>

read-onlyrequired

Example:

app_module

string

required

Name of app module the Notification is related to. Localized

Example:

operations_documents

type

enum<string>

required

!!TODO!! Types should be documented somewhere

Allowed value:

operations_alert_accepted

Example:

operations_alert_accepted

body

string

required

Content of the Notification. Localized

Example:

APPROVED: Holiday promo coupon 10% discount

url

string

required

Relative URL to a MPC page related to the event

Example:

447;type=customer/resources/details/23

occurred_at

string <date-time>

required

When the Event that triggered the Notification occurred

Example:

2022-11-09T16:25:58.099512Z

created_at

string <date-time>

read-onlyrequired

When the Notification has been created

Example:

2022-11-05T16:25:58.099512Z

received_at

required

When the Notification has been received by the user

seen_at

required

When the Notification has been seen by user for the last time

Example

{
    "notification": {
        "id": 1,
        "app_module": "operations_documents",
        "type": "operations_alert_accepted",
        "body": "APPROVED: Holiday promo coupon 10% discount",
        "url": "447;type=customer/resources/details/23",
        "occurred_at": "2022-11-09T16:25:58.099512Z",
        "created_at": "2022-11-05T16:25:58.099512Z",
        "received_at": "2022-11-09T16:25:58.099512Z",
        "seen_at": "2022-11-09T16:25:58.099512Z"
    }
}