openapi: 3.2.0
info:
title: simpplr-api-gateway Alerts API
version: '1.0'
servers:
- url: https://api.ec.simpplr.com/api
security:
- sec0: []
tags:
- name: Alerts
paths:
/alerts:
post:
summary: Create an Alert
description: Use this API to create a new Alert.
operationId: create-a-new-alert
parameters:
- name: x-user-email
in: header
description: User's email to login into Salesforce
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- message
- display-from
- display-to
- is-dismissible
- has-url
- recipient
properties:
message:
type: string
description: The Alert message to be displayed on the pop up
default: This is an alert message
display-from:
type: string
description: 'Time from which this Alert should be displayed. Format : YYYY-MM-DDTH:mm:ss+05:30'
default: '2022-02-12T00:00:00+05:30'
display-to:
type: string
description: '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'
default: '2022-03-12T00:00:00+05:30'
segment-id:
type: string
description: 'ID of the Segment in which this Alert should be created. Note: Will work only if Segmentation is enabled for your org'
default: 'null'
is-dismissible:
type: boolean
description: 'true: The Alert can be dismissed by users. false: The Alert cannot be dismissed by users.'
default: false
members-type:
type: string
description: 'Which group of members should this Alert be displayed to. Note: Applicable only if the recipient is set as Site'
default: site_members
enum:
- site_members
- site_members_and_followers
has-url:
type: boolean
description: Will this Alert have a hyperlink to redirect the users to a particular page
default: false
url:
type: string
description: Target link for the Alert (REQUIRED if has-url is true)
recipient:
type: string
description: Recipient group for this Alert
default: site
enum:
- everyone
- audience
- site
- segment
site-id:
type: string
description: ID of the target site (If recipient is chosen as site)
audience-id:
type: string
description: Audience ID
audience-count:
type: integer
description: Audience Count
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"result\": {\n \"attributes\": {\n \"type\": \"Alert__c\",\n \"url\": \"/services/data/v52.0/sobjects/Alert__c/a025e000008Vvxxxxx\"\n },\n \"Alert_Message__c\": \"This is alert message\",\n \"Alert_Url__c\": null,\n \"Author__c\": \"a115e000002FFxxxxx\",\n \"Display_From_DateTime__c\": \"2021-12-09T05:33:04.000+0000\",\n \"Display_To_DateTime__c\": \"2021-12-10T05:33:04.000+0000\",\n \"Is_Dismissible__c\": false,\n \"Is_Link_Alert__c\": false,\n \"Members_Type__c\": \"site_members\",\n \"Recipient__c\": \"everyone\",\n \"Recipient_Count__c\": 5,\n \"Recipient_Site__c\": null,\n \"Audience__c\": null,\n \"Id\": \"a025e000008Vvxxxxx\"\n },\n \"responseTimeStamp\": \"1631615203892\",\n \"message\": \"\"\n}"
schema:
type: object
properties:
status:
type: string
example: success
result:
type: object
properties:
attributes:
type: object
properties:
type:
type: string
example: Alert__c
url:
type: string
example: /services/data/v52.0/sobjects/Alert__c/a025e000008Vvxxxxx
Alert_Message__c:
type: string
example: This is alert message
Alert_Url__c: {}
Author__c:
type: string
example: a115e000002FFxxxxx
Display_From_DateTime__c:
type: string
example: 2021-12-09T05:33:04.000+0000
Display_To_DateTime__c:
type: string
example: 2021-12-10T05:33:04.000+0000
Is_Dismissible__c:
type: boolean
example: false
default: true
Is_Link_Alert__c:
type: boolean
example: false
default: true
Members_Type__c:
type: string
example: site_members
Recipient__c:
type: string
example: everyone
Recipient_Count__c:
type: integer
example: 5
default: 0
Recipient_Site__c: {}
Audience__c: {}
Id:
type: string
example: a025e000008Vvxxxxx
responseTimeStamp:
type: string
example: '1631615203892'
message:
type: string
example: ''
'400':
description: '400'
content:
application/json:
examples:
Result:
value: "{\n \"statusCode\": 400,\n \"status\": \"error\",\n \"message\": \"\",\n \"data\": {}\n}"
schema:
type: object
properties:
statusCode:
type: integer
example: 400
default: 0
status:
type: string
example: error
message:
type: string
example: ''
data:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: SESSION_TIMEOUT
i18nmessage:
type: string
example: SESSION_TIMEOUT
deprecated: false
tags:
- Alerts
get:
summary: Search for Alerts
description: Use this API to search for Alerts.
operationId: search-for-alerts
parameters:
- name: size
in: query
description: Page size
schema:
type: integer
format: int32
default: 10
- name: filter
in: query
description: How to filter Alerts
schema:
type: string
enum:
- all
- active
- expired
- scheduled
default: all
- name: sort-by
in: query
description: Sorting order for Alerts
schema:
type: string
enum:
- createdNewest
- createdOldest
- displayFromNewest
- displayFromOldest
- displayToNewest
- displayToOldest
default: createdNewest
- name: recipient
in: query
description: 'Receiving audience. Allowed values: everyone , {site-id}'
schema:
type: string
default: everyone
- name: term
in: query
description: Search term
schema:
type: string
- name: x-user-email
in: header
description: User's email to login into Salesforce
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"result\": {\n \"filterOptions\": {\n \"sites\": [\n {\n \"title\": \"Arun test site\",\n \"id\": \"a1A5e000001wJxxxxx\n },\n {\n \"title\": \"Arun Test site 1\",\n \"id\": \"a1A5e000001wxxxxxx\"\n },\n {\n \"title\": \"Test API Site\",\n \"id\": \"a1A5e000001wKxxxxx\"\n },\n {\n \"title\": \"Test API Site 100\",\n \"id\": \"a1A5e000001wRxxxxx\"\n },\n {\n \"title\": \"Test API Site 11\",\n \"id\": \"a1A5e000001wxxxxx\"\n },\n {\n \"title\": \"Test API Site 214124\",\n \"id\": \"a1A5e000001wRxxxxx\"\n },\n {\n \"title\": \"Test API Site 22\",\n \"id\": \"a1A5e000001wxxxxx\"\n },\n {\n \"title\": \"Test API Site arun\",\n \"id\": \"a1A5e000001wQxxxxx\"\n },\n {\n \"title\": \"Test API Site kaushik\",\n \"id\": \"a1A5e000001wxxxxx\"\n },\n {\n \"title\": \"Test API Site Sourya\",\n \"id\": \"a1A5e000001wSxxxxx\"\n },\n {\n \"title\": \"Test API Site_2\",\n \"id\": \"a1A5e000001wXxxxxx\"\n }\n ]\n },\n \"nextPageToken\": 1,\n \"listOfItems\": [\n {\n \"status\": \"scheduled\",\n \"seenCount\": 0,\n \"recipientCount\": 5,\n \"recipient\": \"everyone\",\n \"modifiedAt\": \"2021-09-14T16:15:34.000+0530\",\n \"message\": \"This is alert message\",\n \"membersType\": \"site_members\",\n \"isDismissible\": false,\n \"displayTo\": \"2021-12-10T11:03:04.000+0530\",\n \"displayFrom\": \"2021-12-09T11:03:04.000+0530\",\n \"createdAt\": \"2021-09-14T16:15:34.000+0530\",\n \"canDelete\": true,\n \"authoredBy\": {\n \"videoCallProvider\": \"zoom\",\n \"userId\": \"0055e000006GGxxxxx\",\n \"url\": \"https://xxxxx.visualforce.com/apex/app?u=/people/a115e000002Fxxxxx\",\n \"peopleId\": \"a115e000002FFxxxxx\",\n \"name\": \"Arun Cherian\"\n },\n \"alertId\": \"a025e000008Vvxxxxx\"\n }\n ]\n },\n \"responseTimeStamp\": \"1631617695480\",\n \"message\": \"\"\n}"
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: SESSION_TIMEOUT
i18nmessage:
type: string
example: SESSION_TIMEOUT
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "\n\n\n\n\t\n\tError\n\n\n\n\tCannot GET /alertsssss
\n\n\n"
deprecated: false
tags:
- Alerts
/alerts/{alert-id}:
put:
summary: Update an Alert
description: Use this API to update an Alert.
operationId: update-an-alert
parameters:
- name: alert-id
in: path
description: ID of the Alert to be updated
schema:
type: string
default: a025e000008VvrlAAC
required: true
- name: x-user-email
in: header
description: User's email to login into Salesforce
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- message
- is-dismissible
- has-url
- recipient
properties:
message:
type: string
description: Alert message
default: This is an updated Alert message
site-id:
type: string
description: ID of the Site
default: a194W000009TBFdQAO
is-dismissible:
type: boolean
description: 'true: The Alert can be dismissed by users. false: The Alert cannot be dismissed by users.'
default: false
has-url:
type: boolean
description: Will this Alert have a hyperlink to redirect the users to a particular page
default: false
url:
type: string
description: Target link for the Alert (REQUIRED if has-url is true)
recipient:
type: string
description: Recipient group for this Alert
default: site
enum:
- everyone
- audience
- site
- segment
audience-id:
type: string
description: Audience ID. REQUIRED if recipient is set as audience
display-to:
type: string
description: 'Alert display End Date Time -: YYYY-MM-DDTH:mm:ss+05:30'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"result\": {\n \"attributes\": {\n \"type\": \"Alert__c\",\n \"url\": \"/services/data/v52.0/sobjects/Alert__c/a025e000008Vvxxxxx\"\n },\n \"Id\": \"a025e000008Vvxxxxx\",\n \"Members_Type__c\": null,\n \"Alert_Message__c\": \"test updated123@\",\n \"Alert_Url__c\": null,\n \"Author__c\": \"a115e000002FFxxxxx\",\n \"Display_From_DateTime__c\": \"2021-09-14T13:19:08.319+0000\",\n \"Display_To_DateTime__c\": null,\n \"Is_Dismissible__c\": true,\n \"Is_Link_Alert__c\": false,\n \"Recipient__c\": \"site\",\n \"Recipient_Site__c\": null,\n \"Audience__c\": null,\n \"Recipient_Count__c\": 6\n },\n \"responseTimeStamp\": \"1631625548559\",\n \"message\": \"\"\n}"
schema:
type: object
properties:
status:
type: string
example: success
result:
type: object
properties:
attributes:
type: object
properties:
type:
type: string
example: Alert__c
url:
type: string
example: /services/data/v52.0/sobjects/Alert__c/a025e000008Vvxxxxx
Id:
type: string
example: a025e000008Vvxxxxx
Members_Type__c: {}
Alert_Message__c:
type: string
example: test updated123@
Alert_Url__c: {}
Author__c:
type: string
example: a115e000002FFxxxxx
Display_From_DateTime__c:
type: string
example: 2021-09-14T13:19:08.319+0000
Display_To_DateTime__c: {}
Is_Dismissible__c:
type: boolean
example: true
default: true
Is_Link_Alert__c:
type: boolean
example: false
default: true
Recipient__c:
type: string
example: site
Recipient_Site__c: {}
Audience__c: {}
Recipient_Count__c:
type: integer
example: 6
default: 0
responseTimeStamp:
type: string
example: '1631625548559'
message:
type: string
example: ''
'400':
description: '400'
content:
text/plain:
examples:
Result:
value: "{\n \"statusCode\": 400,\n \"status\": \"error\",\n \"message\": \"\",\n \"data\": {}\n}"
schema:
type: object
properties:
statusCode:
type: integer
example: 400
default: 0
status:
type: string
example: error
message:
type: string
example: ''
data:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: SESSION_TIMEOUT
i18nmessage:
type: string
example: SESSION_TIMEOUT
'404':
description: '404'
content:
text/plain:
examples:
Result:
value: "\n\n\n\n\t\n\tError\n\n\n\n\tCannot PUT /alerts/
\n\n\n"
deprecated: false
tags:
- Alerts
delete:
summary: Delete an Alert
description: Use this API to delete an Alert.
operationId: delete-an-alert
parameters:
- name: alert-id
in: path
description: ID of the alert to be deleted.
schema:
type: string
default: a025e000008VvymAAC
required: true
- name: x-user-email
in: header
description: User's email to login into Salesforce
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"result\": {\n \"attributes\": {\n \"type\": \"Alert__c\",\n \"url\": \"/services/data/v52.0/sobjects/Alert__c/a025e000008Vxxxxx\"\n },\n \"Id\": \"a025e000008Vxxxxx\",\n \"Is_Deleted__c\": true\n },\n \"responseTimeStamp\": \"1631623863578\",\n \"message\": \"\"\n}"
schema:
type: object
properties:
status:
type: string
example: success
result:
type: object
properties:
attributes:
type: object
properties:
type:
type: string
example: Alert__c
url:
type: string
example: /services/data/v52.0/sobjects/Alert__c/a025e000008Vxxxxx
Id:
type: string
example: a025e000008Vxxxxx
Is_Deleted__c:
type: boolean
example: true
default: true
responseTimeStamp:
type: string
example: '1631623863578'
message:
type: string
example: ''
'400':
description: '400'
content:
text/plain:
examples:
Result:
value: "{\n \"statusCode\": 400,\n \"status\": \"error\",\n \"message\": \"\",\n \"data\": {}\n}"
schema:
type: object
properties:
statusCode:
type: integer
example: 400
default: 0
status:
type: string
example: error
message:
type: string
example: ''
data:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: SESSION_TIMEOUT
i18nmessage:
type: string
example: SESSION_TIMEOUT
'404':
description: '404'
content:
text/plain:
examples:
Result:
value: "\n\n\n\n\t\n\tError\n\n\n\n\tCannot DELETE /alerts/
\n\n\n"
deprecated: false
tags:
- Alerts
/alerts/{alert-id}?expire=true:
put:
summary: Expire an Alert
description: Use this API to expire an active Alert.
operationId: expire-an-alert
parameters:
- name: alert-id
in: path
schema:
type: string
default: a025e000008VvrlAAC
required: true
- name: x-user-email
in: header
description: User's email to login into Salesforce
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"result\": {\n \"status\": \"expired\",\n \"seenCount\": 0,\n \"recipientCount\": 5,\n \"recipient\": \"everyone\",\n \"modifiedAt\": \"2021-09-14T17:37:07.000+0530\",\n \"message\": \"Updated alert message!\",\n \"membersType\": \"site_members\",\n \"isDismissible\": true,\n \"displayTo\": \"2021-12-10T11:03:04.000+0530\",\n \"displayFrom\": \"2021-09-14T17:27:48.000+0530\",\n \"createdAt\": \"2021-09-14T11:51:22.000+0530\",\n \"canDelete\": false,\n \"authoredBy\": {\n \"videoCallProvider\": \"zoom\",\n \"userId\": \"0055e000006GGxxxxx\",\n \"url\": \"https://xxxxxxx.visualforce.com/apex/app?u=/people/a115e000002FFncAAG\",\n \"peopleId\": \"a115e000002FFncAAG\",\n \"name\": \"Arun Cherian\"\n },\n \"alertId\": \"a025e000008Vxxxxx\"\n },\n \"responseTimeStamp\": \"1631621234526\",\n \"message\": \"\"\n}"
schema:
type: object
properties:
status:
type: string
example: success
result:
type: object
properties:
status:
type: string
example: expired
seenCount:
type: integer
example: 0
default: 0
recipientCount:
type: integer
example: 5
default: 0
recipient:
type: string
example: everyone
modifiedAt:
type: string
example: 2021-09-14T17:37:07.000+0530
message:
type: string
example: Updated alert message!
membersType:
type: string
example: site_members
isDismissible:
type: boolean
example: true
default: true
displayTo:
type: string
example: 2021-12-10T11:03:04.000+0530
displayFrom:
type: string
example: 2021-09-14T17:27:48.000+0530
createdAt:
type: string
example: 2021-09-14T11:51:22.000+0530
canDelete:
type: boolean
example: false
default: true
authoredBy:
type: object
properties:
videoCallProvider:
type: string
example: zoom
userId:
type: string
example: 0055e000006GGxxxxx
url:
type: string
example: https://xxxxxxx.visualforce.com/apex/app?u=/people/a115e000002FFncAAG
peopleId:
type: string
example: a115e000002FFncAAG
name:
type: string
example: Arun Cherian
alertId:
type: string
example: a025e000008Vxxxxx
responseTimeStamp:
type: string
example: '1631621234526'
message:
type: string
example: ''
'400':
description: '400'
content:
text/plain:
examples:
Result:
value: "{\n \"statusCode\": 400,\n \"status\": \"error\",\n \"message\": \"\",\n \"data\": {}\n}"
schema:
type: object
properties:
statusCode:
type: integer
example: 400
default: 0
status:
type: string
example: error
message:
type: string
example: ''
data:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: SESSION_TIMEOUT
i18nmessage:
type: string
example: SESSION_TIMEOUT
deprecated: false
tags:
- Alerts
components:
securitySchemes:
sec0:
type: oauth2
flows: {}
x-readme-fauxas: true
x-provenance:
method: searched
source: https://developer.simpplr.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developer.simpplr.com/reference/add-a-follower-to-a-site.md
- https://developer.simpplr.com/reference/add-a-member-to-a-site.md
- https://developer.simpplr.com/reference/add-audience.md
- https://developer.simpplr.com/reference/app-adoption-1.md
- https://developer.simpplr.com/reference/app-adoption-average.md
- https://developer.simpplr.com/reference/app-adoption.md
- https://developer.simpplr.com/reference/app-page-views.md
- https://developer.simpplr.com/reference/autocomplete.md
- https://developer.simpplr.com/reference/campaigns.md
- https://developer.simpplr.com/reference/content-engagement.md
- https://developer.simpplr.com/reference/content-publications.md
- https://developer.simpplr.com/reference/content-referral-sources.md
- https://developer.simpplr.com/reference/content-views-by-type.md
- https://developer.simpplr.com/reference/content-views-list.md
- https://developer.simpplr.com/reference/create-a-blog.md
- https://developer.simpplr.com/reference/create-a-new-alert.md
- https://developer.simpplr.com/reference/create-a-notification.md
- https://developer.simpplr.com/reference/create-a-site.md
- https://developer.simpplr.com/reference/create-an-event.md
- https://developer.simpplr.com/reference/delete-a-blog.md
- https://developer.simpplr.com/reference/delete-a-page-by-id.md
- https://developer.simpplr.com/reference/delete-album-images-by-ids.md
- https://developer.simpplr.com/reference/delete-an-alert.md
- https://developer.simpplr.com/reference/delete-an-event-by-id.md
- https://developer.simpplr.com/reference/delete-audience.md
- https://developer.simpplr.com/reference/expire-an-alert.md
- https://developer.simpplr.com/reference/get-all-events.md
- https://developer.simpplr.com/reference/get-blog-by-id.md
- https://developer.simpplr.com/reference/get-carousel-data.md
- https://developer.simpplr.com/reference/get-must-read-content.md
- https://developer.simpplr.com/reference/get-site-by-id.md
- https://developer.simpplr.com/reference/knowledge-page-stats.md
- https://developer.simpplr.com/reference/low-activity-sites.md
- https://developer.simpplr.com/reference/news-letters.md
- https://developer.simpplr.com/reference/people-count.md
- https://developer.simpplr.com/reference/people-performance.md
- https://developer.simpplr.com/reference/people-profile-completeness.md
- https://developer.simpplr.com/reference/remove-a-follower-from-a-site.md
- https://developer.simpplr.com/reference/remove-a-member-from-a-site.md
- https://developer.simpplr.com/reference/search-for-a-page-by-id.md
- https://developer.simpplr.com/reference/search-for-alerts.md
- https://developer.simpplr.com/reference/search-for-an-event-by-id.md
- https://developer.simpplr.com/reference/search-for-contents.md
- https://developer.simpplr.com/reference/search-for-notifications.md
- https://developer.simpplr.com/reference/search-for-people.md
- https://developer.simpplr.com/reference/search-for-site-by-id.md
- https://developer.simpplr.com/reference/search-for-sites.md
- https://developer.simpplr.com/reference/search-list-1.md
- https://developer.simpplr.com/reference/search-list.md
- https://developer.simpplr.com/reference/search-page-categories.md
- https://developer.simpplr.com/reference/search-within-a-section.md
- https://developer.simpplr.com/reference/search-within-feed.md
- https://developer.simpplr.com/reference/searches.md
- https://developer.simpplr.com/reference/site-count.md
- https://developer.simpplr.com/reference/site-popularity.md
- https://developer.simpplr.com/reference/site-publications.md
- https://developer.simpplr.com/reference/social-engagement-list.md
- https://developer.simpplr.com/reference/social-engagement.md
- https://developer.simpplr.com/reference/update-a-blog.md
- https://developer.simpplr.com/reference/update-a-notification.md
- https://developer.simpplr.com/reference/update-a-page.md
- https://developer.simpplr.com/reference/update-a-site.md
- https://developer.simpplr.com/reference/update-an-alert.md
- https://developer.simpplr.com/reference/update-an-event.md
- https://developer.simpplr.com/reference/update-audience.md
- https://developer.simpplr.com/reference/update-people.md
- https://developer.simpplr.com/reference/update-site-as-active.md
merge:
pages: 67
deduped: 66
conflicts_kept_first: 0