Synup
Create a key
v1Resources/Social Inbox/postTag an inbox item

Tag an inbox item

Adds and removes tags on one item. Name tags by id or by name, as listed by the tags endpoint. A tag that does not exist is refused by name, because new tags are created in the app, and an archived tag cannot be added.

post/api/v1/inbox/{kind}/{id}/tags
inbox:write
Query parameters
kindstring (comment | message | mention)required
The kind of item: a comment, a direct message conversation or a mention.
idstringrequired
The item's id, from the inbox list.
Request body
addarray of stringoptional
Tags to add, by id or name.
removearray of stringoptional
Tags to remove, by id or name.
Response
dataobjectoptional
okbooleanoptional
True when the tags were changed.
addedarray of stringoptional
The names of the tags that were added.
removedarray of stringoptional
The names of the tags that were removed.
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/inbox/{kind}/{id}/tags
Your API key
kind *
id *
Request body
{
  "data": {
    "ok": true,
    "added": [
      "VIP"
    ],
    "removed": []
  }
}

New to the Synup API?