Metricool Notification Preferences Api Service API

openapi: 3.2.0
info:
  title: Metricool Notification Preferences 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: Notification Preferences Api Service
paths:
  /v2/settings/users/{userId}/notification-preferences:
    get:
      tags:
      - Notification Preferences Api Service
      summary: Get the authenticated user's notification preferences
      operationId: get_5
      parameters:
      - name: userId
        in: path
        description: Authenticated user id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Resolved notification preferences matrix
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseNotificationPreferencesDto'
        '403':
          description: Delegated proxy sessions (integrator/alias/Vendasta) cannot manage preferences
    put:
      tags:
      - Notification Preferences Api Service
      summary: Update one or more cells of the notification preferences matrix
      operationId: update_5
      parameters:
      - name: userId
        in: path
        description: Authenticated user id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotificationPreferencesRequest'
        required: true
      responses:
        '200':
          description: Resolved notification preferences matrix after the update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseNotificationPreferencesDto'
  /v2/settings/users/{userId}/notification-preferences/email-global:
    put:
      tags:
      - Notification Preferences Api Service
      summary: Toggle the global email opt-out flag
      operationId: updateEmailGloballyOff
      parameters:
      - name: userId
        in: path
        description: Authenticated user id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailGloballyOffRequest'
        required: true
      responses:
        '200':
          description: Resolved notification preferences matrix after the update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseNotificationPreferencesDto'
components:
  schemas:
    NotificationEventPreferenceDto:
      type: object
      properties:
        event:
          type: string
          description: Event id
          example: postError
        channels:
          type: array
          description: Effective state per channel
          items:
            $ref: '#/components/schemas/NotificationChannelPreferenceDto'
      description: Resolved notification preferences for a single event, across all channels
    UpdateEmailGloballyOffRequest:
      required:
      - emailGloballyOff
      type: object
      properties:
        emailGloballyOff:
          type: boolean
          description: When true, all EMAIL channel notifications are disabled regardless of per-event overrides
          example: true
      description: Request to toggle the global email opt-out flag
    UpdateNotificationPreferenceRequest:
      required:
      - channel
      - enabled
      - event
      type: object
      properties:
        event:
          minLength: 1
          type: string
          description: Event id
          example: postError
        channel:
          minLength: 1
          type: string
          description: Channel id
          example: email
        enabled:
          type: boolean
          description: Desired enabled state
          example: false
      description: A single granular change to the notification preferences matrix
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    JsonOkResponseNotificationPreferencesDto:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/NotificationPreferencesDto'
    NotificationPreferencesDto:
      type: object
      properties:
        events:
          type: array
          description: Resolved matrix, one entry per event
          items:
            $ref: '#/components/schemas/NotificationEventPreferenceDto'
        emailGloballyOff:
          type: boolean
          description: Global email opt-out flag; when true, every EMAIL channel is effectively disabled
          example: false
      description: Full resolved notification preferences matrix for the authenticated user
    NotificationChannelPreferenceDto:
      type: object
      properties:
        channel:
          type: string
          description: Channel id
          example: email
        enabled:
          type: boolean
          description: Effective enabled state after applying the per-cell override, the global email opt-out and the event default
          example: true
      description: Effective enabled state of a notification event for a single channel
    UpdateNotificationPreferencesRequest:
      required:
      - changes
      type: object
      properties:
        changes:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/UpdateNotificationPreferenceRequest'
      description: Batch of granular changes to apply to the notification preferences matrix