v1Ressources/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
inbox:write/api/v1/inbox/{kind}/{id}/tagsParamè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
addarray of stringfacultatif
Tags to add, by id or name.
removearray of stringfacultatif
Tags to remove, by id or name.
Réponse
dataobjectfacultatif
okbooleanfacultatif
True when the tags were changed.
addedarray of stringfacultatif
The names of the tags that were added.
removedarray of stringfacultatif
The names of the tags that were removed.
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}/tags
Votre clé API
kind *
id *
Corps de la requête
{
"data": {
"ok": true,
"added": [
"VIP"
],
"removed": []
}
}