Create an Alert

post

https://api.ec.simpplr.com/api/alerts

Use this API to create a new Alert.

Body Params

message

string

required

Defaults to This is an alert message

The Alert message to be displayed on the pop up

display-from

string

required

Defaults to 2022-02-12T00:00:00+05:30

Time from which this Alert should be displayed. Format : YYYY-MM-DDTH:mm:ss+05:30

display-to

string

required

Defaults to 2022-03-12T00:00:00+05:30

Time till which the Alert should be displayed. By default it will be 24 hours from the display-from value. Format: YYYY-MM-DDTH:mm:ss+05:30

segment-id

string

Defaults to null

ID of the Segment in which this Alert should be created. Note: Will work only if Segmentation is enabled for your org

is-dismissible

boolean

required

Defaults to false

true: The Alert can be dismissed by users. false: The Alert cannot be dismissed by users.

members-type

string

enum

Defaults to site_members

Which group of members should this Alert be displayed to. Note: Applicable only if the recipient is set as Site

Allowed:

has-url

boolean

required

Defaults to false

Will this Alert have a hyperlink to redirect the users to a particular page

url

string

Target link for the Alert (REQUIRED if has-url is true)

recipient

string

enum

required

Defaults to site

Recipient group for this Alert

Allowed:

site-id

string

ID of the target site (If recipient is chosen as site)

audience-id

string

Audience ID

audience-count

int32

Audience Count

Headers

x-user-email

string

required

User's email to login into Salesforce

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401