Metricool Organization Collaborators Api Service API

openapi: 3.2.0
info:
  title: Metricool Organization Collaborators 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: Organization Collaborators Api Service
paths:
  /v2/organizations/{organizationId}/collaborators:
    get:
      tags:
      - Organization Collaborators Api Service
      summary: List the collaborators of an organization.
      operationId: getCollaborators
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Collaborators retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseBrandRoleCollaborator'
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot read the collaborators of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
  /v2/organizations/{organizationId}/collaborators/{collaboratorId}:
    put:
      tags:
      - Organization Collaborators Api Service
      summary: Update the brand assignments of an organization's collaborator.
      operationId: updateCollaboratorAssignments
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: collaboratorId
        in: path
        description: Id of the collaborator to update
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BrandRoleAssignment'
        required: true
      responses:
        '200':
          description: Assignments updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseBrandRoleAssignment'
        '400':
          description: Invalid request body, or the target is already a team member of this organization.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, the caller cannot manage the collaborators of this organization, or the target is the caller themselves.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
    delete:
      tags:
      - Organization Collaborators Api Service
      summary: Remove a collaborator from an organization.
      operationId: deleteCollaborator
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: collaboratorId
        in: path
        description: Id of the collaborator to remove
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: True if the collaborator was removed; false if none of their assignments was on a brand of this organization, so nothing was removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage the collaborators of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
  /v2/organizations/{organizationId}/collaborators/{collaboratorId}/activation-link:
    post:
      tags:
      - Organization Collaborators Api Service
      summary: Resend the invitation to a collaborator of an organization who has not…
      operationId: resendActivationLink_2
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: collaboratorId
        in: path
        description: Id of the collaborator to invite again
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailActivationInfo'
        required: true
      responses:
        '200':
          description: True if the invitation was sent; null if the collaborator has already activated their account or it was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
        '400':
          description: Invalid request body, the collaborator has no enabled assignment on a brand the caller manages here, or the last invitation was sent less than an hour ago.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage the collaborators of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
  /v2/organizations/{organizationId}/collaborators/{email}:
    post:
      tags:
      - Organization Collaborators Api Service
      summary: Add a new collaborator to an organization.
      operationId: addCollaborator
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: email
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandRoleAssignmentsRequest'
        required: true
      responses:
        '200':
          description: Collaborator added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBrandRoleCollaborator'
        '400':
          description: Invalid request body, or the target is already a collaborator or a team member of this organization.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, the caller cannot manage the collaborators of this organization, or the target is the caller themselves.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
components:
  schemas:
    JsonOkListResponseBrandRoleCollaborator:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/BrandRoleCollaborator'
    BrandRoleCollaborator:
      type: object
      properties:
        userId:
          type: integer
          format: int32
        email:
          type: string
        fullName:
          type: string
        isUserActive:
          type: boolean
        lastSent:
          $ref: '#/components/schemas/DateTimeInfo'
        assignments:
          type: array
          items:
            $ref: '#/components/schemas/BrandRoleAssignment'
        profilePicture:
          type: string
          description: Public URL of the collaborator's 400x400 profile picture. Absent when they have none, in which case the frontend renders its initials fallback.
    BrandRoleAssignment:
      type: object
      properties:
        id:
          type: integer
          format: int64
        blogId:
          type: integer
          format: int32
        userId:
          type: integer
          format: int32
        email:
          type: string
        blogName:
          type: string
        enabled:
          type: boolean
        roleId:
          type: integer
          format: int64
        roleName:
          type: string
    EmailActivationInfo:
      required:
      - isDefaultEmail
      type: object
      properties:
        isDefaultEmail:
          type: boolean
        invitationCustomMessage:
          type: string
        useNewActivationLink:
          type: boolean
    BrandRoleAssignmentsRequest:
      type: object
      properties:
        isDefaultEmail:
          type: boolean
        invitationCustomMessage:
          type: string
        assignments:
          type: array
          items:
            $ref: '#/components/schemas/BrandRoleAssignment'
        useNewActivationLink:
          type: boolean
    JsonOkResponseBoolean:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: boolean
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    JsonOkResponseBrandRoleCollaborator:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/BrandRoleCollaborator'
    JsonOkListResponseBrandRoleAssignment:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/BrandRoleAssignment'
    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