---
title: "PUT /v2/inbox/notes/{noteId}"
method: PUT
path: "/v2/inbox/notes/{noteId}"
tags: ["Inbox Notes Api Service"]
---

# PUT /v2/inbox/notes/{noteId}

`PUT /v2/inbox/notes/{noteId}`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/inbox/notes/{noteId}`
- Auth: none declared

## Path parameters

- `noteId` integer, required

## Request body

- InboxNoteRequest
  - `participantScreenName` string
  - `participantAccountId` string
  - `provider` string
  - `content` string, required

## Response `200`

OK

- JsonOkResponseInboxNote
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` InboxNote
    - `id` integer, required
    - `contextBlogId` integer, required
    - `participantScreenName` string
    - `participantAccountId` string
    - `provider` string, required
    - `userId` integer: Regular user id of the note author. Absent for an agency end client.
    - `agencyId` integer: Agency id of the note author. Only for an agency end client.
    - `agencyUserId` integer: Agency user id of the note author. Only for an agency end client.
    - `userName` string, required: Name to render for the author. Never an email address: an agency end client is stored under a display name, and a regular author's stored address is replaced on read for any session not entitled to see it.
    - `created` DateTimeInfo, required
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `content` string, required
    - `updatedDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `updated` boolean
    - `deletedDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `deleted` boolean
    - `profilePicture` string: Public URL of the author's 400x400 profile picture. Absent when they have none, in which case the frontend renders its initials fallback. Always absent for an agency end client — agency pictures are out of scope.
    - `mentions` NoteMentionDto[]: Users mentioned in the content of the note, resolved when the note is read. Empty when the note mentions nobody.
      - `userId` integer: Regular user id of the mentioned user. Absent for an agency end client.
      - `agencyId` integer: Agency id of the mentioned user. Only for an agency end client.
      - `agencyUserId` integer: Agency user id of the mentioned user. Only for an agency end client.
      - `name` string: Current display name of the mentioned user. Absent when the account was deleted, in which case the frontend renders its own localized deleted-user label.
      - `deleted` boolean: True when the mentioned account no longer exists. A user that merely lost access to the brand is not deleted: their mention keeps rendering as it always did.
    - `mentionId` string: Identity of the note author, and the field to compare against your own to tell whether a note is yours. `12345` for a regular user, `a:<agencyId>:<agencyUserId>` for an agency end client. Prefer it over the raw id fields: an agency author has no `userId` at all, so comparing that one answers "not mine" on their own note. Same shape as the `mentionId` of the mention picker, so the author of a note and the entry that mentions them carry the same string. Absent only for a note whose author could not be resolved.

---

[API](https://skmtc.dev/metricool/apis/metricool-api.md) · [All operations](https://skmtc.dev/metricool/apis/metricool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metricool/apis/metricool-api/revisions/aea9d9a8415a?raw)