v1Recursos/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
Parámetros de consulta
kindstring (comment | message | mention)obligatorio
The kind of item: a comment, a direct message conversation or a mention.
idstringobligatorio
The item's id, from the inbox list.
Cuerpo de la solicitud
addarray of stringopcional
Tags to add, by id or name.
removearray of stringopcional
Tags to remove, by id or name.
Respuesta
dataobjectopcional
okbooleanopcional
True when the tags were changed.
addedarray of stringopcional
The names of the tags that were added.
removedarray of stringopcional
The names of the tags that were removed.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/inbox/{kind}/{id}/tags
Su clave de API
kind *
id *
Cuerpo de la solicitud
{
  "data": {
    "ok": true,
    "added": [
      "VIP"
    ],
    "removed": []
  }
}

¿Nuevo en la API de Synup?