Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

2.5 KB
Raw Blame
get:
  tags:
    - Profile
  operationId: fetchProfile
  summary: Fetch user profile
  description: Get the user profile details
  security:
    - userBearerAuth: []
    - userApiKey: []
  responses:
    '200':
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/user'
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/bad_request_error'
put:
  tags:
    - Profile
  operationId: updateProfile
  summary: Update user profile
  description: Update the user profile details
  security:
    - userBearerAuth: []
    - userApiKey: []
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          required:
            - profile
          properties:
            profile:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                display_name:
                  type: string
                message_signature:
                  type: string
                phone_number:
                  type: string
                current_password:
                  type: string
                password:
                  type: string
                password_confirmation:
                  type: string
                ui_settings:
                  type: object
      multipart/form-data:
        schema:
          type: object
          required:
            - profile
          properties:
            profile:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                display_name:
                  type: string
                message_signature:
                  type: string
                phone_number:
                  type: string
                current_password:
                  type: string
                password:
                  type: string
                password_confirmation:
                  type: string
                avatar:
                  type: string
                  format: binary
                ui_settings:
                  type: object
  responses:
    '200':
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/user'
    '401':
      description: Unauthorized