Annonces

Mettre à jour une annonce

Met à jour une annonce déjà publiée.

Scope requis announces:edit

patch/announcements/{id}

Authentification

Authorizationstringobligatoire

En-tête Authorization portant une clé d'API de l'espace de travail, sous la forme « Bearer kbn_live_… ». L'en-tête X-Api-Key est accepté de façon équivalente.

Paramètres de chemin

idstring<uuid>obligatoire

Identifiant de la ressource visée.

Corps de la requêteapplication/json

titlestring

Titre.

contentstring

Corps du texte.

typestring

Type de la ressource.

startDatestring<date-time>

Date de début.

endDatestring<date-time>

Date de fin.

teamsstring<uuid>[]

Équipes concernées.

appstring<uuid>

Application à laquelle l'annonce se rapporte.

Réponse200 · application/json

L'annonce mise à jour.

idstring<uuid>obligatoire

Identifiant unique.

titlestringobligatoire

Titre affiché aux utilisateurs.

contentstringobligatoire

Corps de l'annonce.

typestringobligatoire

Type d'annonce.

teamsstring<uuid>[]

Équipes destinataires de l'annonce.

appstring<uuid> | null

Application à laquelle l'annonce se rapporte.

startDatestring<date-time>obligatoire

Date à partir de laquelle l'annonce est affichée.

endDatestring<date-time> | null

Date à laquelle l'annonce cesse d'être affichée.

createdAtstring<date-time>

Horodatage de création.

updatedAtstring<date-time>

Horodatage de la dernière modification, utilisable pour détecter les changements.

seenCountinteger

Nombre d'utilisateurs ayant vu l'annonce.

likeCountinteger

Nombre de réactions positives.

dislikeCountinteger

Nombre de réactions négatives.

likeRationumber | null

Part de réactions positives.