v1Resources/Social Inbox/postApply inbox actions
Apply inbox actions
Requires an active agency user with Social access and Social Inbox enabled. User visibility and credential client restrictions are intersected. Provide exactly one of items (1–2000 kind/id pairs) or a structured filter object, not a URL string. Supported actions: resolve, reopen, resolveThread, markRead, markUnread, save, unsave. Filters use arrays, real date strings and typed booleans; unknown fields are refused. Every selected item is authorized before writes. resolveThread also checks expanded items and the 2000-item cap. Returns updated/skipped; read/unread skips DMs. Changes internal state without sending messages. Bulk actions can partially complete if a later write fails.
post
inbox:write/api/v1/inbox/actionsRequest body
itemsarray of objectoptional
kindstring (comment | message | mention)required
idstringrequired
filterobjectoptional
clientIdstringoptional
locationsarray of stringoptional
fromstringoptional
tostringoptional
tzintegeroptional
platformarray of stringoptional
statusarray of string (open | resolved)optional
sentimentarray of string (positive | neutral | negative)optional
assigneestring (all | unassigned | me | team)optional
keywordstringoptional
sortstring (newest | oldest)optional
typesarray of stringoptional
sourcesarray of stringoptional
savedbooleanoptional
tagsarray of stringoptional
tagMatchstring (any | all)optional
untaggedbooleanoptional
languagearray of stringoptional
needsResponsestring (yes | no)optional
intentarray of string (question | complaint | praise | feedback | lead | other)optional
spamstring (exclude | only)optional
priorityarray of string (1 | 2 | 3 | 4 | none)optional
caseTypearray of string (general | support | question | feedback | lead)optional
poststringoptional
pulsestring (closing | reply | fresh)optional
actionstring (resolve | reopen | resolveThread | markRead | markUnread | save | unsave)required
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The requested change conflicts with the current record.
413More than 2000 items match or belong to expanded threads; narrow the selection.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The inbox operation could not be completed.
post/api/v1/inbox/actions
Your API key
Request body*
{}