v1Resources/Social Inbox/postAssign an inbox item

Assign an inbox item

Assigns an item to a teammate. An item can have several owners. Assigning the same person again updates the note and does not notify them again; a new assignee is notified in the app. The assignment is recorded as made by the integration.

post/api/v1/inbox/{kind}/{id}/assignee
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
assigneeUserIdstringrequired
The teammate's user id.
notestringoptional
An optional note for the assignee, up to 2,000 characters.
Response
dataobjectoptional
okbooleanoptional
True when the item was assigned.
assigneeUserIdstringoptional
The teammate it was assigned to.
notifiedbooleanoptional
True when the assignee was notified.
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}/assignee
Your API key
kind *
id *
Request body*
{
  "data": {
    "ok": true,
    "assigneeUserId": "usr_123",
    "notified": true
  }
}

New to the Synup API?