Modifier une notification

Afficher en Markdown
Modifie une notification existante. <Note title="Rôle requis"> Aucun. Autorisés : le propriétaire. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de chemin

notificationIdstringRequis
L'identifiant de la notification.

Requête

This endpoint expects an object.
isUnreadbooleanRequis

Indique si la notification a été lue.

Réponse

L’entité Notification mise à jour.

createdlong

La date de création de l’entité.

eventTypestring

Le type d’événement concerné par la notification.

idstring
L'identifiant de la notification.
isUnreadboolean

Indique si la notification a été lue.

tenantIdstring
L'identifiant du tenant auquel appartient la notification.
updatedlong

La date de dernière modification de l’entité.

creatorstringOptionnel

L’identifiant de l’utilisateur à l’origine de la notification.

creatorNamestringOptionnel

Le nom de l’utilisateur à l’origine de la notification.

creatorPictureResourceIdstringOptionnel

L’identifiant de la ressource photo de l’utilisateur à l’origine de la notification.

linkUrlstringOptionnel

L’URL de la page liée à la notification.

preferredLocalestringOptionnel

La locale préférée pour les emails de notification envoyés au destinataire.

sendingStatestringOptionnel

L’état d’envoi courant de la notification : pending, sending ou sent.

stepTypeenumOptionnel

Le type d’étape concernée par la notification : signature ou approval.

userIdstringOptionnel
L'identifiant de l'utilisateur auquel appartient la notification.
workflowIdstringOptionnel

L’identifiant du parapheur concerné par la notification.

workflowNamestringOptionnel

Le nom du parapheur concerné par la notification.

emailstringOptionnel

L’adresse email du destinataire concerné par la notification.

stepIdstringOptionnel

L’identifiant de l’étape du parapheur concernée par la notification, le cas échéant.

jobOperationstringOptionnel

L’opération de tâche en cours d’exécution.

Erreurs

403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error