Sign in
latestOpenAPI 3.0.02026-07-135965404.0 KB

a1bd874b5960

Notifications

Update a notification

Update an existing notification. You can add additional emails or change the action or users that cause a notification to trigger.

When updating recipient emails, make sure your recipients parameter contains the full list of people who should be included on the notification. If you resend the list without an existing recipient, they will be deleted from the notification emails.

Notes:

  • You need to have the notifications permission to update a notification.
  • You can only change notifications owned by your user account.
patch/notifications/{id}

Path parameters

idinteger required

ID of the notification. Use GET /notifications if you need to lookup an ID.

Headers

ev-api-keystring required

API Key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Request body

action'upload' | 'download' | 'delete' | 'all'

Type of action be notified about. Notifications will only be sent for the given type of action. Valid choices are upload, download, delete or all (upload/download/delete)

usernamesstring[]

Determines which users' actions should trigger the notification.

Rather than listing individual users, you can also use 3 special options:

  • notice_user_all for activity by any user or share recipient
  • notice_user_all_users for activity only by user accounts
  • notice_user_all_recipients for activity only by share recipients
sendEmailboolean

Whether an email should be sent to the recipients when matching activity happens.

recipientsstring[]

Email addresses to send notification emails to. If empty, sends to the current user's email address.

messagestring

Custom message to insert into the notification emails, along with the matching activity.

Example request

{
  "action": "all",
  "usernames": [
    "notice_user_all"
  ],
  "sendEmail": true,
  "recipients": [
    "myemail@example.com"
  ]
}

Response

Successful Operation

NotificationResponse required— unresolved $ref