# Edit client

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /client:
    put:
      summary: Edit client
      deprecated: false
      description: Update client info and workspace permissions.
      tags:
        - Client Access
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientRequest'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericSuccessResponse'
              example:
                status: success
          headers: {}
          x-apidog-name: OK
      security:
        - ApiKeyAuth: []
          x-apidog:
            schemeGroups:
              - id: Z66RM9Kc7-cnmO94V8ag-
                schemeIds:
                  - ApiKeyAuth
            required: true
            use:
              id: Z66RM9Kc7-cnmO94V8ag-
            scopes:
              Z66RM9Kc7-cnmO94V8ag-:
                ApiKeyAuth: []
      x-apidog-folder: Client Access
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-24563839-run
components:
  schemas:
    UpdateClientRequest:
      allOf:
        - type: object
          x-apidog-refs: {}
          x-apidog-orders:
            - workspace_id
            - client_id
            - client_first_name
            - client_last_name
            - client_business_name
            - notify_pos_reply_email
            - workspaces
          properties:
            workspace_id:
              type: string
              description: >-
                Workspace ID you (the API user) have access to. Does **not**
                determine the workspace assigned to the client.
              examples:
                - 65f99a0dd96fae8ab61130c0
            client_id:
              type: string
            client_first_name:
              type: string
              examples:
                - Nova
            client_last_name:
              type: string
              examples:
                - Smith
            client_business_name:
              type: string
              examples:
                - Nova Consulting Ltd
            notify_pos_reply_email:
              type: string
              description: Positive reply notification to comma-separated emails
            workspaces:
              type: array
              items:
                $ref: '#/components/schemas/ClientWorkspacePermission'
          required:
            - workspace_id
            - client_id
            - client_first_name
            - workspaces
          x-apidog-ignore-properties: []
      x-apidog-folder: ''
    ClientWorkspacePermission:
      type: object
      required:
        - id
        - permissions
        - hide_labels
      properties:
        id:
          type: string
          description: Workspace ID where this client has permissions
          examples:
            - 65f99a0dd96fae8ab61130c0
        permissions:
          type: array
          description: |
            Array that must contain exactly **one** permission.
            Allowed values:
                    - FULL_ACCESS (application full access)
                    - UNIBOX_FULL_ACCESS (Unibox-only access)
          items:
            type: string
          examples:
            - - FULL_ACCESS
        hide_labels:
          type: array
          description: Labels hidden from this client in UI, e.g. NOT_INTERESTED
          items:
            type: string
          examples:
            - - NOT_INTERESTED
      x-apidog-orders:
        - id
        - permissions
        - hide_labels
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    GenericSuccessResponse:
      type: object
      properties:
        status:
          type: string
          examples:
            - success
      x-apidog-orders:
        - status
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    ApiKeyAuth:
      type: apikey
      in: header
      name: x-api-key
      description: |
        API key issued in the PlusVibe dashboard. The server reads it
        from the `x-api-key` header and injects it into the request as
        the `api_key` query parameter, which is why you will see
        `api_key` referenced in validation errors.
    apiKey:
      type: apikey
      in: body
      name: api_key
      description: API key passed in request body
servers:
  - url: https://api.plusvibe.ai/api/v1
    description: Prod Env
security:
  - ApiKeyAuth: []
    x-apidog:
      schemeGroups:
        - id: uS5KiuC4wfZHK42AzOfA_
          schemeIds:
            - ApiKeyAuth
      required: true
      use:
        id: uS5KiuC4wfZHK42AzOfA_
      scopes:
        uS5KiuC4wfZHK42AzOfA_:
          ApiKeyAuth: []

```