API Reference

Update an Alert

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

Use this API to update an Alert.

Path Params
string
required
Defaults to a025e000008VvrlAAC

ID of the Alert to be updated

Body Params
string
required
Defaults to This is an updated Alert message

Alert message

string
Defaults to a194W000009TBFdQAO

ID of the Site

boolean
required
Defaults to false

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

boolean
required
Defaults to false

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

string

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

string
enum
required
Defaults to site

Recipient group for this Alert

Allowed:
string

Audience ID. REQUIRED if recipient is set as audience

string

Alert display End Date Time -: YYYY-MM-DDTH:mm:ss+05:30

Headers
string
required

User's email to login into Salesforce

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 1 year ago

Did this page help you?