nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Prevent notifications when using REST API

Rosario De Domenico

I am using the Confluence REST API for our Server installation in VBA macros to update (change or add) attachments to Confluence pages and to edit the page content.

Everything works fine but currently I have many subsequent API calls to a given page each of which triggers a notification e-mail to all people watching the page.

Is there an option in the API that I can use to use the "save" instead of the "save and notify" option?

Alternatively, is there a way to combine multiple calls to a given page so that they are all done together?

Accepted answers

Stephen Sifers

Hello Rosario,

Using the Confluence API allows for easier integration and awesome amounts of automation. When you’re editing multiple (hundreds of pages) at a time, and all those watches get notifications it can be painful to deal with. I have experienced the exact issue you are trying to avoid when bulk updating/automating.

There is a feature request to give you additional functionality to disable notifications of watchers. That Feature request can be found at CONFSERVER-38804 for server and for cloud CONFCLOUD-38804. If you are interested in seeing these feature become part of the product then we would suggest you vote and watch them to receive updates as they progress.

There is a way to disable notifications upon updating content. The work around is from the server feature request and it states the following:

Workaround

Comment from development:

Suppressing notifications upon updating a content via REST is already supported. You currently have to supply a version with an incremented number in the request payload. Add the "minorEdit" field to the

The version payload also supports minor edits and comments as follow

"version" : {
  "number"    : incrementedFromPrevious,
  "minorEdit" : true,
  "message"   : "some version comment to keep on the content history"
}

As stated above, without the work around, watchers of a space/page will be notified on creation/update of content.

I hope this clarifies the capabilities of the Confluence REST API along with a possible work around to your problem.

Regards,
Stephen Sifers

All comments

Stephen Sifers

Hello Rosario,

There is a way to disable notifications upon updating content. The work around is from the server feature request and it states the following:

Workaround

Comment from development:

Suppressing notifications upon updating a content via REST is already supported. You currently have to supply a version with an incremented number in the request payload. Add the "minorEdit" field to the

The version payload also supports minor edits and comments as follow

"version" : {
  "number"    : incrementedFromPrevious,
  "minorEdit" : true,
  "message"   : "some version comment to keep on the content history"
}

As stated above, without the work around, watchers of a space/page will be notified on creation/update of content.

I hope this clarifies the capabilities of the Confluence REST API along with a possible work around to your problem.

Regards,
Stephen Sifers

Rosario De Domenico

Is there a similar workaround also for adding or updating attachments?

Forget the question this is already possible in the API call itself...

Pavel_efjizj

I started using "minorEdit" : true, no more page change messages. But a lot of messages about adding attachments. This is not good!

norbert_jp367i

@Rosario De Domenico How do you disable notification when uploading or deleting attachments? The minorEdit thing does not seem to apply there.

Thanks!

Jake Stone_jxhqjb

How do we prevent notifications when creating a new page?

KOSHTI NIKHILESH

With the minorEdit =True option like below:-
"version": {
"number":41,
"minorEdit" : "true",
},

Watchers are still getting email about content changes. THough emails were sent after some delay . It would be helpful if someone guide in this issue.

Chris P__bfs417

(Also posted on:

https://community.atlassian.com/t5/Confluence-questions/Rest-API-how-to-disable-page-creation-update-notifications/qaq-p/1316180

)

Thanks guys > did the same thing (remove watchers).

This was an issue for us when we were only updating attachments via API (vs content with a body).

Tried with both:

"minorEdit" : True

and

"minorEdit" : False

included in API call data field, and it would still notify watchers via email.

Solution was to remove all watchers, update attachments, and the re-add the watchers back to affected pages.

Resources:

Get watches for page

Remove watches for page

Add content watcher

Kieran Anthony Baines

My answer somehow duplicated but I'm unable to remove this answer - please disregard.

Kieran Anthony Baines

If you're using REST API, you can disable notifications when updating page HTML or creating/updating attachments - you do not need to remove watchers, the code below works for me.

NOTE: My Confluence is server-based, not cloud-based.

# create request session
session = requests.Session()
session.headers.update({
    "Accept": "application/json",
    "Authorization": f"Bearer {pat}"
})

Updating Page HTML:

payload = {
    "id": page_id,
    "type": "page",
    "title": title,
    "version": {"number": version_number, "minorEdit": True},  # minorEdit hides notifs
    "body": {"storage": {"value": new_html, "representation": "storage"}},
}
url = f"{server_url}/rest/api/content/{page_id}"
session.put(url, json=payload)

Creating/Updating Attachments:

multipart_headers = {"X-Atlassian-Token": "nocheck"}
files = {"file": (filename, png_bytes, "image/png")}
data = {"minorEdit": "true"}  # minorEdit hides notifs

# url to create
url = f"{server_url}/rest/api/content/{page_id}/child/attachment"

# url to update
url = f"{server_url}/rest/api/content/{page_id}/child/attachment/{attachment_id}/data"

session.post(url, data=data, files=files, headers=multipart_headers)

I was experiencing the same issue and sending out 100s of notifications from my pipeline. The lack of documentation on this issue is alarming, I found this method through trial and error. Please update the Atlassian docs.

Hope this helps!

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

server

confluence-server

rest-api

atl-adm