Skip to navigation
ObjectsComment

Comment display name

The Comment Display Name object represents the author name that shows up for a comment. This overrides the default author name when specified.

Request format (input)

Object properties

ParameterTypeDescriptionExample value
typestring (enum)Possible type values are:"integration", "user", or "custom""user"
customobjectIf the type is "custom", include a custom object specifying the custom name "custom": { "name": <Custom Name> }"custom": { "name": "Notion Bot" }
  • "integration": name of the integration
  • "user": name of the user who authenticated the integration (only for Public Integrations)
  • "custom": any custom name

Example of a Create Comment request with custom display name:

API request
{
  "parent": {
    "page_id": "d0a1ffaf-a4d8-4acf-a1ed-abae6e110418"
  },
  "rich_text": [
    {
      "text": {
        "content": "Thanks for checking us out!"
      }
    }
  ],
  "display_name": {
    "type": "custom",
    "custom": {
      "name": "Notion Bot"
    }
  }
}

Response format (output)

Object properties

The response of Comment APIs like Create comment contains attachments with the following fields:

FieldTypeDescriptionExample value
typestring (enum)Possible type values are:"integration", "user", or "custom""custom"
resolved_namestringThe custom display name shown in a comment"Notion Bot"

API Response
{
  ...existing parameters omitted,
  "display_name": {
    "type": "custom",
    "resolved_name": "Notion Bot"
  }
}