Confluence · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Confluence Cloud REST API v2 Content Properties API
46 actions
46 updates
phrasing
extends
openapi/confluence-content-properties-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
What the actions change
x-apievangelist-phrasing
Targets 46 · first 16 shown; the file carries all of them
$.info
$.paths['/attachments/{attachment-id}/properties'].get
$.paths['/attachments/{attachment-id}/properties'].post
$.paths['/attachments/{attachment-id}/properties/{property-id}'].get
$.paths['/attachments/{attachment-id}/properties/{property-id}'].put
$.paths['/attachments/{attachment-id}/properties/{property-id}'].delete
$.paths['/blogposts/{blogpost-id}/properties'].get
$.paths['/blogposts/{blogpost-id}/properties'].post
$.paths['/blogposts/{blogpost-id}/properties/{property-id}'].get
$.paths['/blogposts/{blogpost-id}/properties/{property-id}'].put
$.paths['/blogposts/{blogpost-id}/properties/{property-id}'].delete
$.paths['/custom-content/{custom-content-id}/properties'].get
$.paths['/custom-content/{custom-content-id}/properties'].post
$.paths['/custom-content/{custom-content-id}/properties/{property-id}'].get
$.paths['/custom-content/{custom-content-id}/properties/{property-id}'].put
$.paths['/custom-content/{custom-content-id}/properties/{property-id}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 Content Properties API
version: 1.0.0
extends: openapi/confluence-content-properties-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 45
- target: $.paths['/attachments/{attachment-id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on an attachment
effect: read
questions:
- What custom metadata properties are stored on a Confluence attachment?
- Can I filter an attachment's content properties by a specific key?
instructions:
- text: List all content properties on attachment {attachment_id}.
slots:
attachment_id: path.attachment-id
- text: Find the property with key {key} on attachment {attachment_id}.
slots:
key: query.key
attachment_id: path.attachment-id
method: generated
generated: '2026-10-01'
- target: $.paths['/attachments/{attachment-id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to an attachment
effect: write
questions:
- How do I store my own key-value metadata on an uploaded attachment?
- Can an app attach a JSON property to a file attachment?
instructions:
- text: Create a property {key} with value {value} on attachment {attachment_id}.
slots:
key: requestBody.key
value: requestBody.value
attachment_id: path.attachment-id
- text: Tag attachment {attachment_id} with a new content property named {key}.
slots:
attachment_id: path.attachment-id
key: requestBody.key
method: generated
generated: '2026-10-01'
- target: $.paths['/attachments/{attachment-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one attachment content property by id
effect: read
questions:
- What value does a particular content property hold on an attachment?
- Can I fetch a single attachment property if I already know its property id?
instructions:
- text: Show property {property_id} on attachment {attachment_id}.
slots:
property_id: path.property-id
attachment_id: path.attachment-id
- text: Read the value of attachment property {property_id} from attachment {attachment_id}.
slots:
property_id: path.property-id
attachment_id: path.attachment-id
method: generated
generated: '2026-10-01'
- target: $.paths['/attachments/{attachment-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update an attachment content property
effect: write
questions:
- How do I change the value of an existing property on an attachment?
- Does updating an attachment property require a version number?
instructions:
- text: Set attachment {attachment_id} property {property_id} to {value}.
slots:
attachment_id: path.attachment-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on attachment {attachment_id} as version {version}.
slots:
property_id: path.property-id
attachment_id: path.attachment-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/attachments/{attachment-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from an attachment
effect: destructive
questions:
- Can I remove a stored metadata property from an attachment?
- What happens to an attachment when I delete one of its content properties?
instructions:
- text: Delete property {property_id} from attachment {attachment_id}.
slots:
property_id: path.property-id
attachment_id: path.attachment-id
- text: Remove the content property {property_id} attached to file {attachment_id}.
slots:
property_id: path.property-id
attachment_id: path.attachment-id
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a blog post
effect: read
questions:
- Which content properties have apps stored on a Confluence blog post?
- Can I page through a blog post's properties with a cursor?
instructions:
- text: List the content properties on blog post {blogpost_id}.
slots:
blogpost_id: path.blogpost-id
- text: Look up the blog post property with key {key} on blog post {blogpost_id}.
slots:
key: query.key
blogpost_id: path.blogpost-id
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a blog post
effect: write
questions:
- How do I save custom metadata against a blog post?
- Can I add a new key-value property to an existing blog post?
instructions:
- text: Create property {key} with value {value} on blog post {blogpost_id}.
slots:
key: requestBody.key
value: requestBody.value
blogpost_id: path.blogpost-id
- text: Add a content property called {key} to blog post {blogpost_id}.
slots:
key: requestBody.key
blogpost_id: path.blogpost-id
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one blog post content property by id
effect: read
questions:
- What is stored in a specific property on a blog post?
- Can I retrieve a blog post property directly by its property id?
instructions:
- text: Show property {property_id} on blog post {blogpost_id}.
slots:
property_id: path.property-id
blogpost_id: path.blogpost-id
- text: Get the value of blog post property {property_id} for post {blogpost_id}.
slots:
property_id: path.property-id
blogpost_id: path.blogpost-id
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a blog post content property
effect: write
questions:
- How do I overwrite the value of a property already on a blog post?
- Which version number must I send when editing a blog post property?
instructions:
- text: Set blog post {blogpost_id} property {property_id} to {value}.
slots:
blogpost_id: path.blogpost-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on blog post {blogpost_id} as version {version}.
slots:
property_id: path.property-id
blogpost_id: path.blogpost-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a blog post
effect: destructive
questions:
- Can I remove an app's metadata property from a blog post?
- What permission do I need to delete a property on a blog post?
instructions:
- text: Delete property {property_id} from blog post {blogpost_id}.
slots:
property_id: path.property-id
blogpost_id: path.blogpost-id
- text: Remove the content property {property_id} stored on blog post {blogpost_id}.
slots:
property_id: path.property-id
blogpost_id: path.blogpost-id
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on custom content
effect: read
questions:
- What properties are stored on a piece of custom content?
- Can I sort the properties of a custom content item?
instructions:
- text: List the content properties on custom content {custom_content_id}.
slots:
custom_content_id: path.custom-content-id
- text: Find the custom content property with key {key} on item {custom_content_id}.
slots:
key: query.key
custom_content_id: path.custom-content-id
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to custom content
effect: write
questions:
- How do I attach key-value metadata to an app's custom content item?
- Can I create a new property on custom content my app owns?
instructions:
- text: Create property {key} with value {value} on custom content {custom_content_id}.
slots:
key: requestBody.key
value: requestBody.value
custom_content_id: path.custom-content-id
- text: Add a content property named {key} to custom content {custom_content_id}.
slots:
key: requestBody.key
custom_content_id: path.custom-content-id
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one custom content property by id
effect: read
questions:
- What value is held in a particular property on my custom content?
- Can I read one custom content property by its id instead of listing all of them?
instructions:
- text: Show property {property_id} on custom content {custom_content_id}.
slots:
property_id: path.property-id
custom_content_id: path.custom-content-id
- text: Read custom content property {property_id} from item {custom_content_id}.
slots:
property_id: path.property-id
custom_content_id: path.custom-content-id
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a custom content property
effect: write
questions:
- How do I change a property value on a custom content item?
- Do I have to bump the version when I edit a custom content property?
instructions:
- text: Set custom content {custom_content_id} property {property_id} to {value}.
slots:
custom_content_id: path.custom-content-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on custom content {custom_content_id} as version {version}.
slots:
property_id: path.property-id
custom_content_id: path.custom-content-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from custom content
effect: destructive
questions:
- Can I remove a stored property from a piece of custom content?
- Who is allowed to delete properties on custom content?
instructions:
- text: Delete property {property_id} from custom content {custom_content_id}.
slots:
property_id: path.property-id
custom_content_id: path.custom-content-id
- text: Remove content property {property_id} from custom content item {custom_content_id}.
slots:
property_id: path.property-id
custom_content_id: path.custom-content-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a page
effect: read
questions:
- Which content properties are set on a Confluence page?
- Can I look up a page property by key without knowing its id?
instructions:
- text: List the content properties on page {page_id}.
slots:
page_id: path.page-id
- text: Find the page property with key {key} on page {page_id}.
slots:
key: query.key
page_id: path.page-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a page
effect: write
questions:
- How do I store app data as a property on a page?
- Can I add a custom key-value property to a page without editing its body?
instructions:
- text: Create property {key} with value {value} on page {page_id}.
slots:
key: requestBody.key
value: requestBody.value
page_id: path.page-id
- text: Add a content property called {key} to page {page_id}.
slots:
key: requestBody.key
page_id: path.page-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one page content property by id
effect: read
questions:
- What value does a specific property on a page currently hold?
- Can I fetch a single page property using its property id?
instructions:
- text: Show property {property_id} on page {page_id}.
slots:
property_id: path.property-id
page_id: path.page-id
- text: Read page property {property_id} from page {page_id}.
slots:
property_id: path.property-id
page_id: path.page-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a page content property
effect: write
questions:
- How do I change the value of a property already stored on a page?
- Does editing a page property need the next version number?
instructions:
- text: Set page {page_id} property {property_id} to {value}.
slots:
page_id: path.page-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on page {page_id} as version {version}.
slots:
property_id: path.property-id
page_id: path.page-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a page
effect: destructive
questions:
- Can I remove a content property from a page while keeping the page?
- What permission is needed to delete a property on a page?
instructions:
- text: Delete property {property_id} from page {page_id}.
slots:
property_id: path.property-id
page_id: path.page-id
- text: Remove the content property {property_id} stored on page {page_id}.
slots:
property_id: path.property-id
page_id: path.page-id
method: generated
generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a whiteboard
effect: read
questions:
- What content properties are stored on a Confluence whiteboard?
- Can I limit how many whiteboard properties come back per page?
instructions:
- text: List the content properties on whiteboard {id}.
slots:
id: path.id
- text: Find the whiteboard property with key {key} on whiteboard {id}.
slots:
key: query.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a whiteboard
effect: write
questions:
- How do I attach custom metadata to a whiteboard?
- Can an integration add a key-value property to a whiteboard?
instructions:
- text: Create property {key} with value {value} on whiteboard {id}.
slots:
key: requestBody.key
value: requestBody.value
id: path.id
- text: Add a content property called {key} to whiteboard {id}.
slots:
key: requestBody.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/whiteboards/{whiteboard-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one whiteboard content property by id
effect: read
questions:
- What is stored in a particular property on a whiteboard?
- Can I read a whiteboard property directly by its property id?
instructions:
- text: Show property {property_id} on whiteboard {whiteboard_id}.
slots:
property_id: path.property-id
whiteboard_id: path.whiteboard-id
- text: Read whiteboard property {property_id} from whiteboard {whiteboard_id}.
slots:
property_id: path.property-id
whiteboard_id: path.whiteboard-id
method: generated
generated: '2026-10-01'
- target: $.paths['/whiteboards/{whiteboard-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a whiteboard content property
effect: write
questions:
- How do I change the value of a property on a whiteboard?
- Is a version number required to edit a whiteboard property?
instructions:
- text: Set whiteboard {whiteboard_id} property {property_id} to {value}.
slots:
whiteboard_id: path.whiteboard-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on whiteboard {whiteboard_id} as version {version}.
slots:
property_id: path.property-id
whiteboard_id: path.whiteboard-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/whiteboards/{whiteboard-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a whiteboard
effect: destructive
questions:
- Can I remove a stored property from a whiteboard?
- Who can delete content properties on a whiteboard?
instructions:
- text: Delete property {property_id} from whiteboard {whiteboard_id}.
slots:
property_id: path.property-id
whiteboard_id: path.whiteboard-id
- text: Remove content property {property_id} stored on whiteboard {whiteboard_id}.
slots:
property_id: path.property-id
whiteboard_id: path.whiteboard-id
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a database
effect: read
questions:
- Which content properties are set on a Confluence database?
- Can I filter a database's properties by key?
instructions:
- text: List the content properties on database {id}.
slots:
id: path.id
- text: Find the database property with key {key} on database {id}.
slots:
key: query.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a database
effect: write
questions:
- How do I store custom metadata on a Confluence database?
- Can I add a new key-value property to a database?
instructions:
- text: Create property {key} with value {value} on database {id}.
slots:
key: requestBody.key
value: requestBody.value
id: path.id
- text: Add a content property called {key} to database {id}.
slots:
key: requestBody.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{database-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one database content property by id
effect: read
questions:
- What value does a particular property hold on a database?
- Can I fetch one database property by its property id?
instructions:
- text: Show property {property_id} on database {database_id}.
slots:
property_id: path.property-id
database_id: path.database-id
- text: Read database property {property_id} from database {database_id}.
slots:
property_id: path.property-id
database_id: path.database-id
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{database-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a database content property
effect: write
questions:
- How do I change a property value stored on a database?
- Which version should I send when updating a database property?
instructions:
- text: Set database {database_id} property {property_id} to {value}.
slots:
database_id: path.database-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on database {database_id} as version {version}.
slots:
property_id: path.property-id
database_id: path.database-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{database-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a database
effect: destructive
questions:
- Can I remove a content property from a database without touching its data?
- What permission is needed to delete a database property?
instructions:
- text: Delete property {property_id} from database {database_id}.
slots:
property_id: path.property-id
database_id: path.database-id
- text: Remove content property {property_id} stored on database {database_id}.
slots:
property_id: path.property-id
database_id: path.database-id
method: generated
generated: '2026-10-01'
- target: $.paths['/embeds/{id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a Smart Link
effect: read
questions:
- What content properties are stored on a Smart Link in the content tree?
- Can I sort or paginate the properties of a Smart Link embed?
instructions:
- text: List the content properties on Smart Link {id}.
slots:
id: path.id
- text: Find the Smart Link property with key {key} on embed {id}.
slots:
key: query.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/embeds/{id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a Smart Link
effect: write
questions:
- How do I store custom metadata on a Smart Link in the page tree?
- Can I add a key-value property to an embedded Smart Link?
instructions:
- text: Create property {key} with value {value} on Smart Link {id}.
slots:
key: requestBody.key
value: requestBody.value
id: path.id
- text: Add a content property called {key} to Smart Link embed {id}.
slots:
key: requestBody.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/embeds/{embed-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one Smart Link content property by id
effect: read
questions:
- What value is stored in a specific property on a Smart Link?
- Can I retrieve a Smart Link property directly by its id?
instructions:
- text: Show property {property_id} on Smart Link {embed_id}.
slots:
property_id: path.property-id
embed_id: path.embed-id
- text: Read Smart Link property {property_id} from embed {embed_id}.
slots:
property_id: path.property-id
embed_id: path.embed-id
method: generated
generated: '2026-10-01'
- target: $.paths['/embeds/{embed-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a Smart Link content property
effect: write
questions:
- How do I change a property value on a Smart Link in the content tree?
- Does editing a Smart Link property need a version number?
instructions:
- text: Set Smart Link {embed_id} property {property_id} to {value}.
slots:
embed_id: path.embed-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on Smart Link {embed_id} as version {version}.
slots:
property_id: path.property-id
embed_id: path.embed-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/embeds/{embed-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a Smart Link
effect: destructive
questions:
- Can I remove a stored property from a Smart Link embed?
- Who is allowed to delete properties on a Smart Link?
instructions:
- text: Delete property {property_id} from Smart Link {embed_id}.
slots:
property_id: path.property-id
embed_id: path.embed-id
- text: Remove content property {property_id} stored on Smart Link embed {embed_id}.
slots:
property_id: path.property-id
embed_id: path.embed-id
method: generated
generated: '2026-10-01'
- target: $.paths['/folders/{id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a folder
effect: read
questions:
- Which content properties are set on a Confluence folder?
- Can I look up a folder property by key?
instructions:
- text: List the content properties on folder {id}.
slots:
id: path.id
- text: Find the folder property with key {key} on folder {id}.
slots:
key: query.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/folders/{id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a folder
effect: write
questions:
- How do I attach custom metadata to a folder in a space?
- Can I add a new key-value property to a folder?
instructions:
- text: Create property {key} with value {value} on folder {id}.
slots:
key: requestBody.key
value: requestBody.value
id: path.id
- text: Add a content property called {key} to folder {id}.
slots:
key: requestBody.key
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/folders/{folder-id}/properties/{property-id}'].get
update:
x-apievangelist-phrasing:
intent: Get one folder content property by id
effect: read
questions:
- What is stored in a particular property on a folder?
- Can I fetch a single folder property by its property id?
instructions:
- text: Show property {property_id} on folder {folder_id}.
slots:
property_id: path.property-id
folder_id: path.folder-id
- text: Read folder property {property_id} from folder {folder_id}.
slots:
property_id: path.property-id
folder_id: path.folder-id
method: generated
generated: '2026-10-01'
- target: $.paths['/folders/{folder-id}/properties/{property-id}'].put
update:
x-apievangelist-phrasing:
intent: Update a folder content property
effect: write
questions:
- How do I change a property value stored on a folder?
- Which version do I send when editing a folder property?
instructions:
- text: Set folder {folder_id} property {property_id} to {value}.
slots:
folder_id: path.folder-id
property_id: path.property-id
value: requestBody.value
- text: Update property {property_id} on folder {folder_id} as version {version}.
slots:
property_id: path.property-id
folder_id: path.folder-id
version: requestBody.version
method: generated
generated: '2026-10-01'
- target: $.paths['/folders/{folder-id}/properties/{property-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a content property from a folder
effect: destructive
questions:
- Can I remove a content property from a folder?
- What permission is required to delete a property on a folder?
instructions:
- text: Delete property {property_id} from folder {folder_id}.
slots:
property_id: path.property-id
folder_id: path.folder-id
- text: Remove content property {property_id} stored on folder {folder_id}.
slots:
property_id: path.property-id
folder_id: path.folder-id
method: generated
generated: '2026-10-01'
- target: $.paths['/comments/{comment-id}/properties'].get
update:
x-apievangelist-phrasing:
intent: List content properties on a comment
effect: read
questions:
- What content properties are stored on a Confluence comment?
- Can I filter a comment's properties by key?
instructions:
- text: List the content properties on comment {comment_id}.
slots:
comment_id: path.comment-id
- text: Find the comment property with key {key} on comment {comment_id}.
slots:
key: query.key
comment_id: path.comment-id
method: generated
generated: '2026-10-01'
- target: $.paths['/comments/{comment-id}/properties'].post
update:
x-apievangelist-phrasing:
intent: Add a content property to a comment
effect: write
questions:
- How do I attach app metadata to a comment?
- Can I add a key-value property to a footer or inline comment?
instructions:
- text: Create property {key} with value {value} on comment {comment_id}.
slots:
key: requestBody.key
value: requestBody.value
comment_id: path.comment-id
- text: Add a content property called {key} to comment {comment_id}.
slots:
key: requestBody.key
comment_id: path.comment-id
method: generated
generated: '2026-10-01'
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/overlays/confluence-content-properties-api-phrasing-overlay.yaml