Sprinklr

App · 25 actions

Work with Sprinklr, the enterprise platform for social media and customer care: open, update and find cases, add notes, read and search messages and conversations, reply to customers, schedule posts, and pull the data behind your dashboards. Start a workflow when a case is opened or changes status, a message comes in, or a post goes out.

Actions

ActionWhat it does
Act on messageLike, hide, favorite, approve, reject or delete a message on its social network, from one of your accounts.
Add noteAdd an internal note to a case, message, post, campaign or customer profile, for your team to see.
Create caseOpen a case in Sprinklr for a customer who reached you by email or text, with a subject, description, status, priority, due date and a first note.
Delete caseDelete a case from Sprinklr for good.
Delete noteDelete a note from a case, message, post, campaign or profile.
Delete postDelete a scheduled post so it never goes out, or take a published post down.
Get caseGet a case by its number: subject, status, priority, customer, who it is assigned to, its custom fields and its first and newest messages.
Get case summaryGet Sprinklr AI+'s summary of a case: why the customer got in touch, what your brand did and what is still to do.
Get conversationGet the messages in the conversation a message belongs to, oldest first, such as a whole comment thread or chat.
Get messageGet one message: what it says, who sent it, the channel and account, its link and the case it is on.
Get postGet a scheduled or published post: its text, status, when it goes or went out, and its link once published.
Get widget dataGet the table behind a Reporting dashboard widget for a time range, one row per line of the widget, for a weekly report or a spreadsheet.
List accountsList your brand's social accounts in Sprinklr, or find them by name, with the ID to post or reply from.
List campaignsList your Sprinklr campaigns, which posts and replies are filed under.
List case messagesList the IDs of the messages on a case, oldest first, to read each with 'Get message'.
List case notesList the notes on a case, oldest first.
List dashboardsList your Reporting or Listening dashboards, or find them by name.
List usersList the people who use Sprinklr in your organization, or find one by email, with the ID to assign work to them.
Reply to messageReply to a customer's message or comment from your account it reached, with an optional picture or link.
Schedule postSchedule a post on one of your brand's social accounts for a date and time, filed under a campaign, with an optional picture, video or link.
Search casesFind cases opened or changed in a time range, by the customer's ID on their channel or by a linked case number in another system, such as Salesforce.
Search messagesFind messages Sprinklr received or sent in a time window, newest first: by account, channel, direction, case or words in them.
Update caseChange a case's subject, description, status, priority, type, summary or due date, assign it to someone, or set one of its custom fields.
Update messageAdd an internal note to a message, assign it to someone, or tag it with a custom field value.
Update noteChange what a note says.

Act on message

Like, hide, favorite, approve, reject or delete a message on its social network, from one of your accounts. Not every network allows every action.

Inputs

Message IDmessage_idtextRequired
The message's Sprinklr message ID (it looks like ACCOUNT_600056911_1742986039000_FACEBOOK_470_...), from 'Search messages', a trigger or an earlier step.
AccountaccounttextRequired
Your brand's social account in Sprinklr.
Actionaction_typetextRequired
What to do to the message.One of: LIKE, UNLIKE, HIDE, UNHIDE, FAVORITE, UNFAVORITE, APPROVE, REJECT, DELETE (Delete it from the social network).

Outputs

action_typetext
What was done
donetrue/false
True once Sprinklr took the action
message_idtext
The message
Example output
{
  "action_type": "LIKE",
  "done": true,
  "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150"
}

Add note

Add an internal note to a case, message, post, campaign or customer profile, for your team to see. Customers never see notes.

Inputs

Case number or IDentity_idtextRequired
The case number for a case; otherwise the message, post, campaign or profile ID.
NotetexttextRequired
What the note says.
On aentity_typetext
What kind of record the note is on.One of: CASE (Case (default)), MESSAGE, OUTBOUND_MESSAGE (Post), CAMPAIGN, PROFILE (Customer profile). Default: CASE.

Outputs

noteobject
A note on a Sprinklr record
Example output
{
  "note": {
    "author_user_id": "66015421",
    "created_time": "2026-08-21T10:17:28Z",
    "entity_id": "120331397",
    "entity_type": "CASE",
    "id": "6a8825baa34ff204e0821a61",
    "in_reply_to_note_id": "",
    "is_private": false,
    "modified_time": "2026-08-21T10:17:28Z",
    "text": "Called the customer back; replacement on its way."
  }
}

Create case

Open a case in Sprinklr for a customer who reached you by email or text, with a subject, description, status, priority, due date and a first note.

Inputs

SubjectsubjecttextRequired
What the case is about, in a line.
Channelchannel_typetext
How the customer reached you.One of: EMAIL (Email (default)), SMS (Text message (SMS)). Default: EMAIL.
Customer emailemailtext
The customer's email address. Needed for an email case.
Customer phonephonetext
The customer's phone number with its country code, like +14155550123. Needed for a text message case.
First namefirst_nametext
The customer's first name.
Last namelast_nametext
The customer's last name.
Descriptiondescriptiontext
What the case is about.
Statusstatustext
Its status as your Sprinklr names it, such as Open or Closed.
Priorityprioritytext
Its priority as your Sprinklr names it, such as High.
Case typecase_typetext
Its type as your Sprinklr names it, such as Complaint.
Duedue_datedate and time
When the case must be resolved by.
First notenotetext
An internal note to add to the case.

Outputs

caseobject
A Sprinklr case
Example output
{
  "case": {
    "assignee_id": "66014640",
    "assignee_type": "USER",
    "brand_message_count": 3,
    "case_number": "120331397",
    "case_type": "Complaint",
    "contact_channel_id": "54963396257",
    "contact_channel_type": "INSTAGRAM",
    "contact_id": "INSTAGRAM_54963396257",
    "contact_name": "aptiwadi",
    "conversation_id": "3900635358364111659",
    "created_time": "2026-06-16T13:20:58Z",
    "custom_properties": {
      "spr_uc_priority": [
        "High"
      ]
    },
    "customer_message_count": 1,
    "deleted": false,
    "description": "The customer's order arrived with a cracked screen.",
    "due_date": "",
    "external_case_id": "",
    "external_case_number": "",
    "external_system": "",
    "first_message_id": "ACCOUNT_600037626_1779440700000_INSTAGRAM_37_18442753900191622",
    "id": "6a314dbbe2e30aea511e4181",
    "latest_message_id": "ACCOUNT_600037626_1782297368000_INSTAGRAM_306_17884961964597246",
    "modified_time": "2026-06-24T18:45:40Z",
    "priority": "High",
    "queue_ids": [
      "103197"
    ],
    "sentiment": 0,
    "status": "Open",
    "subject": "#120331397 Instagram Order arrived damaged",
    "summary": "",
    "version": 4
  }
}

Delete case

Delete a case from Sprinklr for good. Its messages stay.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.

Outputs

case_numbertext
The case number deleted
deletedtrue/false
True once the case is deleted
Example output
{
  "case_number": "120331397",
  "deleted": true
}

Delete note

Delete a note from a case, message, post, campaign or profile.

Inputs

Case number or IDentity_idtextRequired
The case number for a case; otherwise the message, post, campaign or profile ID.
Note IDnote_idtextRequired
The note's ID, from 'Add note' or 'List case notes'.
On aentity_typetext
What kind of record the note is on.One of: CASE (Case (default)), MESSAGE, OUTBOUND_MESSAGE (Post), CAMPAIGN, PROFILE (Customer profile). Default: CASE.

Outputs

deletedtrue/false
True once the note is deleted
note_idtext
The note deleted
Example output
{
  "deleted": true,
  "note_id": "6a8825baa34ff204e0821a61"
}

Delete post

Delete a scheduled post so it never goes out, or take a published post down.

Inputs

Post IDpost_idtextRequired
The post's ID, from 'Schedule post' or a trigger.

Outputs

deletedtrue/false
True once the post is deleted
post_idtext
The post deleted
Example output
{
  "deleted": true,
  "post_id": "1234567890"
}

Get case

Get a case by its number: subject, status, priority, customer, who it is assigned to, its custom fields and its first and newest messages.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.

Outputs

caseobject
A Sprinklr case
Example output
{
  "case": {
    "assignee_id": "66014640",
    "assignee_type": "USER",
    "brand_message_count": 3,
    "case_number": "120331397",
    "case_type": "Complaint",
    "contact_channel_id": "54963396257",
    "contact_channel_type": "INSTAGRAM",
    "contact_id": "INSTAGRAM_54963396257",
    "contact_name": "aptiwadi",
    "conversation_id": "3900635358364111659",
    "created_time": "2026-06-16T13:20:58Z",
    "custom_properties": {
      "spr_uc_priority": [
        "High"
      ]
    },
    "customer_message_count": 1,
    "deleted": false,
    "description": "The customer's order arrived with a cracked screen.",
    "due_date": "",
    "external_case_id": "",
    "external_case_number": "",
    "external_system": "",
    "first_message_id": "ACCOUNT_600037626_1779440700000_INSTAGRAM_37_18442753900191622",
    "id": "6a314dbbe2e30aea511e4181",
    "latest_message_id": "ACCOUNT_600037626_1782297368000_INSTAGRAM_306_17884961964597246",
    "modified_time": "2026-06-24T18:45:40Z",
    "priority": "High",
    "queue_ids": [
      "103197"
    ],
    "sentiment": 0,
    "status": "Open",
    "subject": "#120331397 Instagram Order arrived damaged",
    "summary": "",
    "version": 4
  }
}

Get case summary

Get Sprinklr AI+'s summary of a case: why the customer got in touch, what your brand did and what is still to do. Needs Sprinklr AI+.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.
Write a new oneregeneratetrue/false
On to have AI+ write the summary again rather than give the last one.

Outputs

case_numbertext
The case number
summarytext
The summary as plain text
summary_htmltext
The summary as Sprinklr gives it, in HTML
Example output
{
  "case_number": "120331397",
  "summary": "Contact Driver\nDamaged order\nPending actions/next steps\nSend a replacement",
  "summary_html": "<h4>Contact Driver</h4><p>Damaged order</p><h4>Pending actions/next steps</h4><p>Send a replacement</p>"
}

Get conversation

Get the messages in the conversation a message belongs to, oldest first, such as a whole comment thread or chat.

Inputs

Message IDmessage_idtextRequired
The message's Sprinklr message ID (it looks like ACCOUNT_600056911_1742986039000_FACEBOOK_470_...), from 'Search messages', a trigger or an earlier step.
Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 20.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is another page
messageslist
The messages
pagenumber
Which page this is (0 is the first)
Example output
{
  "count": 1,
  "has_more": false,
  "messages": [
    {
      "account_id": "600056911",
      "account_type": "SOCIAL",
      "attachment_url": "",
      "case_number": "120331397",
      "channel_created_time": "2025-03-26T10:47:19Z",
      "channel_message_id": "600275313172150",
      "channel_type": "FACEBOOK",
      "conversation_id": "240539989134747_122199892268193678",
      "created_time": "2025-03-26T10:47:19Z",
      "deleted": false,
      "from_brand": false,
      "id": "64e76b8ad9a9d946c006ca5f",
      "language": "en",
      "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150",
      "parent_message_id": "",
      "permalink": "https://www.facebook.com/600275313172150",
      "receiver_channel_id": "240539989134747",
      "receiver_name": "Acme Support",
      "sender_channel_id": "110103441967171",
      "sender_name": "John Doe",
      "sender_username": "",
      "source_type": "ACCOUNT",
      "text": "Need help with my order #12345",
      "title": ""
    }
  ],
  "page": 0
}

Get message

Get one message: what it says, who sent it, the channel and account, its link and the case it is on.

Inputs

Message IDmessage_idtextRequired
The message's Sprinklr message ID (it looks like ACCOUNT_600056911_1742986039000_FACEBOOK_470_...), from 'Search messages', a trigger or an earlier step.

Outputs

messageobject
A Sprinklr message
Example output
{
  "message": {
    "account_id": "600056911",
    "account_type": "SOCIAL",
    "attachment_url": "",
    "case_number": "120331397",
    "channel_created_time": "2025-03-26T10:47:19Z",
    "channel_message_id": "600275313172150",
    "channel_type": "FACEBOOK",
    "conversation_id": "240539989134747_122199892268193678",
    "created_time": "2025-03-26T10:47:19Z",
    "deleted": false,
    "from_brand": false,
    "id": "64e76b8ad9a9d946c006ca5f",
    "language": "en",
    "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150",
    "parent_message_id": "",
    "permalink": "https://www.facebook.com/600275313172150",
    "receiver_channel_id": "240539989134747",
    "receiver_name": "Acme Support",
    "sender_channel_id": "110103441967171",
    "sender_name": "John Doe",
    "sender_username": "",
    "source_type": "ACCOUNT",
    "text": "Need help with my order #12345",
    "title": ""
  }
}

Get post

Get a scheduled or published post: its text, status, when it goes or went out, and its link once published.

Inputs

Post IDpost_idtextRequired
The post's ID, from 'Schedule post' or a trigger.

Outputs

postobject
A Sprinklr post
Example output
{
  "post": {
    "account_id": "600056911",
    "campaign_id": "66001165_8318",
    "channel_type": "FACEBOOK",
    "conversation_id": "",
    "created_time": "2026-08-21T10:17:28Z",
    "id": "1234567890",
    "media_url": "",
    "modified_time": "2026-08-21T10:17:28Z",
    "permalink": "",
    "published_time": "",
    "scheduled_time": "2026-08-31T23:25:19Z",
    "status": "SCHEDULED",
    "text": "Our autumn range is here."
  }
}

Get widget data

Get the table behind a Reporting dashboard widget for a time range, one row per line of the widget, for a weekly report or a spreadsheet.

Inputs

Widget IDwidget_idtextRequired
The widget's ID: on the widget, open the menu, choose Generate API v2 Payload, and copy widgetId from the additional section.
Fromstartdate and timeRequired
The start of the time range.
Toenddate and time
The end of the time range. Leave blank for now.
Time zonetime_zonetext
The time zone days are counted in, such as America/New_York. Leave blank for UTC.
Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 1000. Leave blank for 100.From 1 to 1000.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is another page
headingslist
The widget's columns, in order
pagenumber
Which page this is (0 is the first)
rowslist
The rows, each with a value for each column heading
Example output
{
  "count": 1,
  "has_more": false,
  "headings": [
    "Channel",
    "Followers"
  ],
  "page": 0,
  "rows": [
    {
      "Channel": "FACEBOOK",
      "Followers": 128394
    }
  ]
}

List accounts

List your brand's social accounts in Sprinklr, or find them by name, with the ID to post or reply from.

Inputs

Namenametext
Only accounts whose name contains this.
Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 50.From 1 to 100.

Outputs

accountslist
The accounts
countnumber
How many are on this page
has_moretrue/false
Whether there is another page
pagenumber
Which page this is (0 is the first)
Example output
{
  "accounts": [
    {
      "account_type": "FBPAGE",
      "active": true,
      "channel_id": "240539989134747",
      "channel_type": "FACEBOOK",
      "id": "600056911",
      "name": "Acme Support",
      "permalink": "https://www.facebook.com/acme",
      "workspace_id": "66000002"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 0
}

List campaigns

List your Sprinklr campaigns, which posts and replies are filed under.

Inputs

Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 50.From 1 to 100.

Outputs

campaignslist
The campaigns
countnumber
How many are on this page
has_moretrue/false
Whether there is another page
pagenumber
Which page this is (0 is the first)
Example output
{
  "campaigns": [
    {
      "archived": false,
      "created_time": "2026-08-31T23:25:19Z",
      "description": "Autumn launch",
      "end_date": "2040-01-07T15:37:01Z",
      "id": "66001165_8318",
      "name": "SampleCampaign",
      "parent_campaign_id": "",
      "start_date": "2019-06-10T09:40:52Z",
      "status": "APPROVED",
      "tags": [
        "Int Tag",
        "Campaign Tag"
      ]
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 0
}

List case messages

List the IDs of the messages on a case, oldest first, to read each with 'Get message'.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.
Sincesincedate and time
Only messages sent at or after this time.
Untiluntildate and time
Only messages sent at or before this time.

Outputs

case_numbertext
The case number
countnumber
How many there are
message_idslist
The messages on the case
Example output
{
  "case_number": "120331397",
  "count": 1,
  "message_ids": [
    "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150"
  ]
}

List case notes

List the notes on a case, oldest first. Gets one page; run it again with the next page token for more.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 50.From 1 to 100.
Next page tokennext_page_tokentext
To get the next page, the 'next_page_token' this step gave last time (it works for five minutes). The other filters are then ignored.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is another page
next_page_tokentext
Give this to the same step to get the next page (it works for five minutes); empty on the last page
noteslist
The notes
Example output
{
  "count": 1,
  "has_more": false,
  "next_page_token": "",
  "notes": [
    {
      "author_user_id": "66015421",
      "created_time": "2026-08-21T10:17:28Z",
      "entity_id": "120331397",
      "entity_type": "CASE",
      "id": "6a8825baa34ff204e0821a61",
      "in_reply_to_note_id": "",
      "is_private": false,
      "modified_time": "2026-08-21T10:17:28Z",
      "text": "Called the customer back; replacement on its way."
    }
  ]
}

List dashboards

List your Reporting or Listening dashboards, or find them by name.

Inputs

Kinddashboard_typetext
Reporting or Listening dashboards.One of: REPORTING (Reporting dashboards (default)), LISTENING (Listening dashboards). Default: REPORTING.
Namenametext
Only dashboards whose name contains this.
Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 50.From 1 to 100.

Outputs

countnumber
How many are on this page
dashboardslist
The dashboards
has_moretrue/false
Whether there is another page
pagenumber
Which page this is (0 is the first)
Example output
{
  "count": 1,
  "dashboards": [
    {
      "created_time": "Aug 05, 2024, 08:13:33 AM",
      "id": "66b089ad242cb400a1a1c653",
      "locked": false,
      "modified_time": "Mar 16, 2026, 07:03:55 AM",
      "module": "REPORTING",
      "name": "Weekly care report",
      "type": "CUSTOM"
    }
  ],
  "has_more": false,
  "page": 0
}

List users

List the people who use Sprinklr in your organization, or find one by email, with the ID to assign work to them.

Inputs

Emailemailtext
Only the user with this email address.
Pagepagenumber
Which page to get: 0 is the first. 'Has more' says whether there is another.At least 0.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 50.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is another page
pagenumber
Which page this is (0 is the first)
userslist
The users
Example output
{
  "count": 1,
  "has_more": false,
  "page": 0,
  "users": [
    {
      "active": true,
      "created_time": "2025-01-21 11:58:00",
      "email": "nitish.kumar@example.com",
      "id": "66016438",
      "modified_time": "2026-05-14 19:50:08",
      "name": "Nitish Kumar",
      "user_name": "nitish.kumar@example.com"
    }
  ]
}

Reply to message

Reply to a customer's message or comment from your account it reached, with an optional picture or link. The reply goes out at once.

Inputs

Message IDmessage_idtextRequired
The message's Sprinklr message ID (it looks like ACCOUNT_600056911_1742986039000_FACEBOOK_470_...), from 'Search messages', a trigger or an earlier step.
AccountaccounttextRequired
Your brand's social account in Sprinklr.
ReplytexttextRequired
What to say.
Campaigncampaigntext
The campaign to file the reply under, if your Sprinklr asks for one.
Media linkmedia_urltext
A picture, video or web page to attach, as a full https:// address.
Media typemedia_typetext
What the media link is.One of: IMAGE (Image (default)), VIDEO, LINK. Default: IMAGE.

Outputs

message_idtext
The message replied to
repliedtrue/false
True once Sprinklr took the reply
reply_idtext
The reply's ID, if Sprinklr gave one
Example output
{
  "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150",
  "replied": true,
  "reply_id": "1234567891"
}

Schedule post

Schedule a post on one of your brand's social accounts for a date and time, filed under a campaign, with an optional picture, video or link.

Inputs

AccountaccounttextRequired
Your brand's social account in Sprinklr.
CampaigncampaigntextRequired
The campaign to file the post under.
TexttexttextRequired
What the post says.
Post atsend_atdate and timeRequired
When it goes out.
Media linkmedia_urltext
A picture, video or web page to attach, as a full https:// address.
Media typemedia_typetext
What the media link is.One of: IMAGE (Image (default)), VIDEO, LINK. Default: IMAGE.

Outputs

postobject
A Sprinklr post
Example output
{
  "post": {
    "account_id": "600056911",
    "campaign_id": "66001165_8318",
    "channel_type": "FACEBOOK",
    "conversation_id": "",
    "created_time": "2026-08-21T10:17:28Z",
    "id": "1234567890",
    "media_url": "",
    "modified_time": "2026-08-21T10:17:28Z",
    "permalink": "",
    "published_time": "",
    "scheduled_time": "2026-08-31T23:25:19Z",
    "status": "SCHEDULED",
    "text": "Our autumn range is here."
  }
}

Search cases

Find cases opened or changed in a time range, by the customer's ID on their channel or by a linked case number in another system, such as Salesforce. Gets one page; run it again with the next page token for more.

Inputs

Opened aftercreated_afterdate and time
Only cases opened at or after this time.
Opened beforecreated_beforedate and time
Only cases opened at or before this time.
Changed afterchanged_afterdate and time
Only cases changed at or after this time.
Changed beforechanged_beforedate and time
Only cases changed at or before this time.
Customer's channel IDcontact_channel_idtext
Only this customer's cases: their ID on the channel, such as a phone number for a text message case.
Linked case numberexternal_case_numbertext
Only the case linked to this case number in another system, such as Salesforce.
Ordersorttext
Which cases come first.One of: modifiedTime:DESC (Last changed first (default)), modifiedTime:ASC (Last changed last), createdTime:DESC (Newest first), createdTime:ASC (Oldest first). Default: modifiedTime:DESC.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 20.From 1 to 100.
Next page tokennext_page_tokentext
To get the next page, the 'next_page_token' this step gave last time (it works for five minutes). The other filters are then ignored.

Outputs

caseslist
The cases
countnumber
How many are on this page
has_moretrue/false
Whether there is another page
next_page_tokentext
Give this to the same step to get the next page (it works for five minutes); empty on the last page
Example output
{
  "cases": [
    {
      "assignee_id": "66014640",
      "assignee_type": "USER",
      "brand_message_count": 3,
      "case_number": "120331397",
      "case_type": "Complaint",
      "contact_channel_id": "54963396257",
      "contact_channel_type": "INSTAGRAM",
      "contact_id": "INSTAGRAM_54963396257",
      "contact_name": "aptiwadi",
      "conversation_id": "3900635358364111659",
      "created_time": "2026-06-16T13:20:58Z",
      "custom_properties": {
        "spr_uc_priority": [
          "High"
        ]
      },
      "customer_message_count": 1,
      "deleted": false,
      "description": "The customer's order arrived with a cracked screen.",
      "due_date": "",
      "external_case_id": "",
      "external_case_number": "",
      "external_system": "",
      "first_message_id": "ACCOUNT_600037626_1779440700000_INSTAGRAM_37_18442753900191622",
      "id": "6a314dbbe2e30aea511e4181",
      "latest_message_id": "ACCOUNT_600037626_1782297368000_INSTAGRAM_306_17884961964597246",
      "modified_time": "2026-06-24T18:45:40Z",
      "priority": "High",
      "queue_ids": [
        "103197"
      ],
      "sentiment": 0,
      "status": "Open",
      "subject": "#120331397 Instagram Order arrived damaged",
      "summary": "",
      "version": 4
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page_token": ""
}

Search messages

Find messages Sprinklr received or sent in a time window, newest first: by account, channel, direction, case or words in them. Without a window, the last 24 hours. Gets one page; run it again with the next page token for more.

Inputs

Sincesincedate and time
Only messages from this time on. Leave blank for 24 hours before 'Until'.
Untiluntildate and time
Only messages up to this time. Leave blank for now.
Accountsaccountslist
Only messages on these accounts of yours.
Channelschannel_typeslist
Only messages on these channels.One or more of: FACEBOOK, INSTAGRAM, TWITTER (X (Twitter)), LINKEDIN, YOUTUBE, TIKTOK, PINTEREST, WHATSAPP_BUSINESS (WhatsApp Business), EMAIL, SMS, and 6 more.
Fromdirectiontext
Messages from customers, from your brand, or both.One of: all (Both (default)), inbound (From customers only), outbound (From your brand only). Default: all.
Case numbercase_numbertext
Only messages on this case.
Wordswordstext
Only messages containing these words.
Page sizepage_sizenumber
How many to get, 1 to 100. Leave blank for 20.From 1 to 100.
Next page tokennext_page_tokentext
To get the next page, the 'next_page_token' this step gave last time (it works for five minutes). The other filters are then ignored.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there is another page
messageslist
The messages
next_page_tokentext
Give this to the same step to get the next page (it works for five minutes); empty on the last page
Example output
{
  "count": 1,
  "has_more": false,
  "messages": [
    {
      "account_id": "600056911",
      "account_type": "SOCIAL",
      "attachment_url": "",
      "case_number": "120331397",
      "channel_created_time": "2025-03-26T10:47:19Z",
      "channel_message_id": "600275313172150",
      "channel_type": "FACEBOOK",
      "conversation_id": "240539989134747_122199892268193678",
      "created_time": "2025-03-26T10:47:19Z",
      "deleted": false,
      "from_brand": false,
      "id": "64e76b8ad9a9d946c006ca5f",
      "language": "en",
      "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150",
      "parent_message_id": "",
      "permalink": "https://www.facebook.com/600275313172150",
      "receiver_channel_id": "240539989134747",
      "receiver_name": "Acme Support",
      "sender_channel_id": "110103441967171",
      "sender_name": "John Doe",
      "sender_username": "",
      "source_type": "ACCOUNT",
      "text": "Need help with my order #12345",
      "title": ""
    }
  ],
  "next_page_token": ""
}

Update case

Change a case's subject, description, status, priority, type, summary or due date, assign it to someone, or set one of its custom fields. Fields left blank keep what they have.

Inputs

Case numbercase_numbertextRequired
The case number, like 120337901, from Sprinklr, a trigger or an earlier step.
Subjectsubjecttext
A new subject.
Descriptiondescriptiontext
What the case is about.
Statusstatustext
Its status as your Sprinklr names it, such as Open or Closed.
Priorityprioritytext
Its priority as your Sprinklr names it, such as High.
Case typecase_typetext
Its type as your Sprinklr names it, such as Complaint.
Summarysummarytext
A summary of the case.
Duedue_datedate and time
A new due date and time.
Assign toassigneetext
The Sprinklr user to assign it to.
Custom fieldcustom_fieldtext
A custom field to set. Give its value in 'Custom field value'.
Custom field valuecustom_field_valuetext
The value for that custom field, as Sprinklr shows it.

Outputs

caseobject
A Sprinklr case
Example output
{
  "case": {
    "assignee_id": "66014640",
    "assignee_type": "USER",
    "brand_message_count": 3,
    "case_number": "120331397",
    "case_type": "Complaint",
    "contact_channel_id": "54963396257",
    "contact_channel_type": "INSTAGRAM",
    "contact_id": "INSTAGRAM_54963396257",
    "contact_name": "aptiwadi",
    "conversation_id": "3900635358364111659",
    "created_time": "2026-06-16T13:20:58Z",
    "custom_properties": {
      "spr_uc_priority": [
        "High"
      ]
    },
    "customer_message_count": 1,
    "deleted": false,
    "description": "The customer's order arrived with a cracked screen.",
    "due_date": "",
    "external_case_id": "",
    "external_case_number": "",
    "external_system": "",
    "first_message_id": "ACCOUNT_600037626_1779440700000_INSTAGRAM_37_18442753900191622",
    "id": "6a314dbbe2e30aea511e4181",
    "latest_message_id": "ACCOUNT_600037626_1782297368000_INSTAGRAM_306_17884961964597246",
    "modified_time": "2026-06-24T18:45:40Z",
    "priority": "High",
    "queue_ids": [
      "103197"
    ],
    "sentiment": 0,
    "status": "Open",
    "subject": "#120331397 Instagram Order arrived damaged",
    "summary": "",
    "version": 4
  }
}

Update message

Add an internal note to a message, assign it to someone, or tag it with a custom field value.

Inputs

Message IDmessage_idtextRequired
The message's Sprinklr message ID (it looks like ACCOUNT_600056911_1742986039000_FACEBOOK_470_...), from 'Search messages', a trigger or an earlier step.
Notenotetext
An internal note to add.
Assign toassigneetext
The Sprinklr user to assign it to.
Custom fieldcustom_fieldtext
A custom field to add a value to. Give the value in 'Custom field value'.
Custom field valuecustom_field_valuetext
The value for that custom field, as Sprinklr shows it.

Outputs

message_idtext
The message changed
updatedtrue/false
True once Sprinklr took the change
Example output
{
  "message_id": "ACCOUNT_600056911_1742986039000_FACEBOOK_470_600275313172150",
  "updated": true
}

Update note

Change what a note says.

Inputs

Case number or IDentity_idtextRequired
The case number for a case; otherwise the message, post, campaign or profile ID.
Note IDnote_idtextRequired
The note's ID, from 'Add note' or 'List case notes'.
NotetexttextRequired
What the note should say now.
On aentity_typetext
What kind of record the note is on.One of: CASE (Case (default)), MESSAGE, OUTBOUND_MESSAGE (Post), CAMPAIGN, PROFILE (Customer profile). Default: CASE.

Outputs

noteobject
A note on a Sprinklr record
Example output
{
  "note": {
    "author_user_id": "66015421",
    "created_time": "2026-08-21T10:17:28Z",
    "entity_id": "120331397",
    "entity_type": "CASE",
    "id": "6a8825baa34ff204e0821a61",
    "in_reply_to_note_id": "",
    "is_private": false,
    "modified_time": "2026-08-21T10:17:28Z",
    "text": "Called the customer back; replacement on its way."
  }
}

On this page