v1Ressources/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
inbox:write/api/v1/inbox/{kind}/{id}/assigneeParamètres de requête
kindstring (comment | message | mention)obligatoire
The kind of item: a comment, a direct message conversation or a mention.
idstringobligatoire
The item's id, from the inbox list.
Corps de la requête
assigneeUserIdstringobligatoire
The teammate's user id.
notestringfacultatif
An optional note for the assignee, up to 2,000 characters.
Réponse
dataobjectfacultatif
okbooleanfacultatif
True when the item was assigned.
assigneeUserIdstringfacultatif
The teammate it was assigned to.
notifiedbooleanfacultatif
True when the assignee was notified.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/inbox/{kind}/{id}/assignee
Votre clé API
kind *
id *
Corps de la requête*
{
"data": {
"ok": true,
"assigneeUserId": "usr_123",
"notified": true
}
}