Metricool Scheduled Post Notes Api Service API

openapi: 3.2.0
info:
  title: Metricool Scheduled Post Notes Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Scheduled Post Notes Api Service
paths:
  /v2/scheduler/posts/{postId}/notes:
    get:
      tags:
      - Scheduled Post Notes Api Service
      operationId: getScheduledPostNote
      parameters:
      - name: postId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseScheduledPostNote'
      summary: Get scheduled post note
      x-summary-source: derived
    post:
      tags:
      - Scheduled Post Notes Api Service
      operationId: createScheduledPostNote
      parameters:
      - name: postId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: sourcePostId
        in: query
        required: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledPostNoteRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseScheduledPostNote'
      summary: Create scheduled post note
      x-summary-source: derived
  /v2/scheduler/posts/{postId}/notes/status:
    put:
      tags:
      - Scheduled Post Notes Api Service
      operationId: setScheduledPostNotesStatus
      parameters:
      - name: postId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
      summary: Set scheduled post notes status
      x-summary-source: derived
  /v2/scheduler/posts/{postId}/notes/{noteId}:
    put:
      tags:
      - Scheduled Post Notes Api Service
      operationId: updateScheduledPostNote
      parameters:
      - name: postId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledPostNoteRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseScheduledPostNote'
      summary: Update scheduled post note
      x-summary-source: derived
    delete:
      tags:
      - Scheduled Post Notes Api Service
      operationId: deleteScheduledPostNoteScheduler
      parameters:
      - name: postId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
      summary: Delete scheduled post note scheduler
      x-summary-source: derived
components:
  schemas:
    NoteMentionDto:
      type: object
      properties:
        userId:
          type: integer
          description: Regular user id of the mentioned user. Absent for an agency end client.
          format: int32
          example: 12345
        agencyId:
          type: integer
          description: Agency id of the mentioned user. Only for an agency end client.
          format: int32
          example: 37
        agencyUserId:
          type: integer
          description: Agency user id of the mentioned user. Only for an agency end client.
          format: int32
          example: 156
        name:
          type: string
          description: 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:
          type: boolean
          description: '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.'
      description: A user mentioned in the content of a note, resolved when the note is read.
    JsonOkResponseBoolean:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: boolean
    JsonOkResponseScheduledPostNote:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/ScheduledPostNote'
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    ScheduledPostNoteRequest:
      required:
      - content
      type: object
      properties:
        content:
          minLength: 1
          type: string
    JsonOkListResponseScheduledPostNote:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduledPostNote'
    DateTimeInfo:
      required:
      - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: 'Local Date-time represented with a certain timezone '
        timezone:
          type: string
          description: Timezone applied to the datetime
    ScheduledPostNote:
      required:
      - content
      - created
      - id
      - postId
      - userName
      type: object
      properties:
        id:
          type: integer
          format: int32
        postId:
          type: integer
          format: int32
        userId:
          type: integer
          format: int32
        agencyId:
          type: integer
          format: int32
        userName:
          minLength: 1
          type: string
        created:
          $ref: '#/components/schemas/DateTimeInfo'
        content:
          minLength: 1
          type: string
        updatedDate:
          $ref: '#/components/schemas/DateTimeInfo'
        updated:
          type: boolean
        deletedDate:
          $ref: '#/components/schemas/DateTimeInfo'
        deleted:
          type: boolean
        profilePicture:
          type: string
          description: Public URL of the author's 400x400 profile picture. Absent when they have none, in which case the frontend renders its initials fallback. Filled for agency-authored notes too.
        mentions:
          type: array
          description: Users mentioned in the content of the note, resolved when the note is read. Empty when the note mentions nobody.
          items:
            $ref: '#/components/schemas/NoteMentionDto'
        mentionId:
          type: string
          description: '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''s `userId` is not a regular-user id — it holds their id inside the agency, which is a different id space and can be the same number as an unrelated regular user, so comparing that one can answer "mine" on somebody else''s 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.'
          example: a:37:156