Create Alert

Pending

POST

https://api.mpc.dev.placewise.com/v1/users/me/operations/alerts

API Permit:Operations:Api:Users:Alerts:Create

API Context:Loyalty Club

Authorizations:UserToken

Creates a new Alert.
Alert then must be accepted.

Body Parameters

Key	Type	Description
alert.audience_id	integer[]	ID of audience that should receive the alert
alert.type	string	Must match available alert types
alert.message	string	Content of message sent to recipients
alert.location	string

Response Body

Key	Type	Description
alert	Alert	See: Alert model

Error Responses

Status	Description
`422`	Invalid parameters - see Invalid parameters errors model

Example

When successful, returns object containing created alert

{
  "alert": {} // Alert - see: 'Alert model'
}

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/users/me/operations/alerts' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'X-Store-Id: '

Responses

🟢200Success

application/json

Body

Example

{}

Show Alert

Report to Alert

Create Alert

Body Parameters#

Response Body#

Error Responses#

Example#

Request

Request Code Samples

Responses

Body Parameters

Response Body

Error Responses

Example