Penpot Update Profile Props API

The Update Profile Props API from Penpot — 1 operation(s) for update profile props.

OpenAPI Specification

penpot-update-profile-props-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: '2.16'
  title: Penpot RPC Add Team To Organization Update Profile Props API
  description: Penpot RPC-style REST API for projects, files, pages, components, and design assets.
  x-api-id: penpot-rpc
  contact:
    url: https://community.penpot.app/
    name: Penpot Support
  x-humanURL: https://penpot.app/integrations-api
servers:
- url: https://design.penpot.app/api/main/methods
  description: MAIN API
tags:
- name: Update Profile Props
paths:
  update-profile-props:
    post:
      description: null
      deprecated: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              title: update-profile-props
              type: object
              properties:
                props:
                  title: ProfileProps
                  type: object
                  properties:
                    plugins:
                      type: object
                      properties:
                        ids:
                          type: array
                          items:
                            type: string
                        data:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              pluginId:
                                type: string
                              name:
                                type: string
                              description:
                                type: string
                              host:
                                type: string
                              code:
                                type: string
                              icon:
                                type: string
                              permissions:
                                type: array
                                items:
                                  type: string
                                uniqueItems: true
                            required:
                            - pluginId
                            - name
                            - host
                            - code
                            - permissions
                      required:
                      - ids
                      - data
                    renderer:
                      title: enum
                      type: string
                      enum:
                      - svg
                      - wasm
                    mcpEnabled:
                      $ref: '#/components/schemas/Boolean'
                    newsletterUpdates:
                      $ref: '#/components/schemas/Boolean'
                    newsletterNews:
                      $ref: '#/components/schemas/Boolean'
                    onboardingTeamId:
                      $ref: '#/components/schemas/Uuid'
                    onboardingViewed:
                      $ref: '#/components/schemas/Boolean'
                    v2InfoShown:
                      $ref: '#/components/schemas/Boolean'
                    welcomeFileId:
                      $ref: '#/components/schemas/Boolean'
                      nullable: true
                    releaseNotesViewed:
                      title: string
                      description: not whitespace string
                      type: string
                    notifications:
                      title: props-notifications
                      type: object
                      properties:
                        dashboardComments:
                          title: enum
                          type: string
                          enum:
                          - all
                          - partial
                          - none
                        emailComments:
                          title: enum
                          type: string
                          enum:
                          - all
                          - partial
                          - none
                        emailInvites:
                          title: enum
                          type: string
                          enum:
                          - all
                          - none
                      required:
                      - dashboardComments
                      - emailComments
                      - emailInvites
                    workspaceVisited:
                      $ref: '#/components/schemas/Boolean'
              required:
              - props
            example: '{"props":{"renderer":"wasm","newsletterUpdates":true,"onboardingTeamId":"5ab5eb30-5b3a-81d5-8008-2a395c5fc67d","onboardingViewed":false}}'
      tags:
      - Update Profile Props
components:
  schemas:
    Boolean:
      title: boolean
      description: boolean
      type: boolean
    Uuid:
      title: uuid
      description: UUID formatted string
      type: string
      format: uuid