Metricool Agency Users Api Service API

openapi: 3.2.0
info:
  title: Metricool Agency Users 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: Agency Users Api Service
paths:
  /v2/settings/agency-users/{agencyUserId}/profile-picture:
    put:
      tags:
      - Agency Users Api Service
      summary: Sets or replaces the agency end-client's own profile picture
      description: 'The request is multipart/form-data with a single file part named ''picture'' — the same contract as POST /v2/media and the other profile-picture endpoints. The image is validated and normalised server-side to a 400x400 PNG, centre-cropped; there is no manual crop. The change is applied immediately and the previous picture is deleted, so it cannot be recovered. Accepted formats PNG, JPEG and WebP, decided from the actual bytes. Maximum upload size 1 MB, and neither side of the source image may exceed 2000 pixels — both are rejections, not automatic downscales. A client may only act on its own picture: there is no agency-side endpoint that sets a client''s avatar, the agency only sees it in GET /v2/agency-CK/{agencyId}/end-clients.'
      operationId: setProfilePicture
      parameters:
      - name: agencyUserId
        in: path
        description: Id of the authenticated agency end client
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The updated agency user, including the new profile picture URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseAgencyUserDto'
        '400':
          description: Missing 'picture' file part, not an image, unsupported format, over 1 MB, a side over 2000 px, or the request does not come from the agency's own domain (NotAllowedOperationException, which this resource maps to 400 rather than 403 — same as PATCH /v2/settings/agency-users/{agencyUserId})
        '401':
          description: Not authenticated as the agency end client of the path
        '404':
          description: The authenticated end client no longer exists
        '415':
          description: Declared content type is not multipart/form-data
    delete:
      tags:
      - Agency Users Api Service
      summary: Removes the agency end-client's own profile picture
      description: 'Idempotent: removing a picture when there is none succeeds and does nothing, so the immediate-apply UI can double-submit safely. With no picture the field is omitted from the response and the UI renders the client''s initials — the backend never returns a generated placeholder URL.'
      operationId: deleteProfilePicture
      parameters:
      - name: agencyUserId
        in: path
        description: Id of the authenticated agency end client
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The updated agency user, with no profile picture
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseAgencyUserDto'
        '400':
          description: The request does not come from the agency's own domain
        '401':
          description: Not authenticated as the agency end client of the path
        '404':
          description: The authenticated end client no longer exists
components:
  schemas:
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    JsonOkResponseAgencyUserDto:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/AgencyUserDto'
    AgencyUserDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        agencyId:
          type: integer
          format: int32
        userName:
          type: string
        name:
          type: string
        lastName:
          type: string
        language:
          type: string
        timezone:
          type: string
        enabled:
          type: boolean
        firstDayOfTheWeek:
          type: integer
          format: int32
        profilePicture:
          type: string