> ## Documentation Index > Fetch the complete documentation index at: https://docs.azalt.co/llms.txt > Use this file to discover all available pages before exploring further. # Update dashboard > Update an existing dashboard: **Required Fields**: - `id`: Dashboard ID to update **Optional Fields**: - `name`: New dashboard name (at least 1 character) - `description`: Updated description (set to null to remove) - `isPublic`: Make dashboard publicly accessible - `publicCanFilterSites`: Allow public dashboard viewers to see and filter sites - `password`: Add password protection (set to null to remove) - `publicAccessEmails`: Allowlisted viewer emails for public access (set to null or [] to remove) - `publicAccessDomains`: Allowlisted viewer email domains for public access (set to null or [] to remove) **Access Requirements**: - Manager permissions or higher required - Must be in the dashboard's organization **Visibility Options**: - Public: Anyone can access without login - Protected public: Anyone can access with password - Email-restricted public: Only allowlisted emails or domains can access - Private: Only organization members can access ## OpenAPI ````yaml https://app.azalt.co/api/v1/openapi.json put /dashboards/{id} openapi: 3.0.3 info: title: Erguvan Public API version: 1.0.0 servers: - url: https://app.azalt.co/api/v1 security: [] paths: /dashboards/{id}: put: tags: - Dashboard summary: Update dashboard description: >- Update an existing dashboard: **Required Fields**: - `id`: Dashboard ID to update **Optional Fields**: - `name`: New dashboard name (at least 1 character) - `description`: Updated description (set to null to remove) - `isPublic`: Make dashboard publicly accessible - `publicCanFilterSites`: Allow public dashboard viewers to see and filter sites - `password`: Add password protection (set to null to remove) - `publicAccessEmails`: Allowlisted viewer emails for public access (set to null or [] to remove) - `publicAccessDomains`: Allowlisted viewer email domains for public access (set to null or [] to remove) **Access Requirements**: - Manager permissions or higher required - Must be in the dashboard's organization **Visibility Options**: - Public: Anyone can access without login - Protected public: Anyone can access with password - Email-restricted public: Only allowlisted emails or domains can access - Private: Only organization members can access operationId: updateDashboard parameters: - in: path name: id schema: type: string required: true requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 description: type: string nullable: true isPublic: type: boolean publicCanFilterSites: type: boolean password: type: string nullable: true publicAccessEmails: type: array nullable: true items: type: string format: email publicAccessDomains: type: array nullable: true items: type: string tags: type: array items: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string name: type: string description: type: string nullable: true organizationId: type: string isPublic: type: boolean publicCanFilterSites: type: boolean hasPassword: type: boolean requiresEmail: type: boolean publicAccessEmails: type: array nullable: true items: type: string format: email publicAccessDomains: type: array nullable: true items: type: string pattern: ^(?!-)(?:[a-z0-9-]{1,63}\.)+[a-z]{2,63}$ order: type: number globalFilter: type: object properties: siteIds: type: array items: type: string startYear: type: number endYear: type: number startDate: type: string endDate: type: string statuses: type: array items: type: string enum: - COMPLETED - APPROVED - REJECTED organizationDefaultStatuses: type: array items: type: string enum: - COMPLETED - APPROVED - REJECTED widgetTheme: type: object properties: mode: type: string enum: - default - oasis - custom customColors: type: array items: type: string pattern: ^#[0-9A-Fa-f]{6}$ aggregateLines: type: object properties: totalColor: type: string pattern: ^#[0-9A-Fa-f]{6}$ averageColor: type: string pattern: ^#[0-9A-Fa-f]{6}$ peerAverageColor: type: string pattern: ^#[0-9A-Fa-f]{6}$ totalLineStyle: type: string enum: - solid - dashed - dotted averageLineStyle: type: string enum: - solid - dashed - dotted peerAverageLineStyle: type: string enum: - solid - dashed - dotted totalStrokeWidth: type: number minimum: 1 maximum: 8 averageStrokeWidth: type: number minimum: 1 maximum: 8 peerAverageStrokeWidth: type: number minimum: 1 maximum: 8 required: - mode tags: type: array nullable: true items: type: string createdAt: type: string updatedAt: type: string required: - id - name - description - organizationId - isPublic - publicCanFilterSites - order - globalFilter - createdAt - updatedAt '400': description: Invalid input data content: application/json: schema: $ref: '#/components/schemas/error.BAD_REQUEST' '401': description: Authorization not provided content: application/json: schema: $ref: '#/components/schemas/error.UNAUTHORIZED' '403': description: Insufficient access content: application/json: schema: $ref: '#/components/schemas/error.FORBIDDEN' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/error.NOT_FOUND' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR' security: - Authorization: [] components: schemas: error.BAD_REQUEST: type: object properties: message: type: string description: The error message example: Invalid input data code: type: string description: The error code example: BAD_REQUEST issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Invalid input data error (400) description: The error information example: code: BAD_REQUEST message: Invalid input data issues: [] error.UNAUTHORIZED: type: object properties: message: type: string description: The error message example: Authorization not provided code: type: string description: The error code example: UNAUTHORIZED issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Authorization not provided error (401) description: The error information example: code: UNAUTHORIZED message: Authorization not provided issues: [] error.FORBIDDEN: type: object properties: message: type: string description: The error message example: Insufficient access code: type: string description: The error code example: FORBIDDEN issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Insufficient access error (403) description: The error information example: code: FORBIDDEN message: Insufficient access issues: [] error.NOT_FOUND: type: object properties: message: type: string description: The error message example: Not found code: type: string description: The error code example: NOT_FOUND issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Not found error (404) description: The error information example: code: NOT_FOUND message: Not found issues: [] error.INTERNAL_SERVER_ERROR: type: object properties: message: type: string description: The error message example: Internal server error code: type: string description: The error code example: INTERNAL_SERVER_ERROR issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Internal server error error (500) description: The error information example: code: INTERNAL_SERVER_ERROR message: Internal server error issues: [] securitySchemes: Authorization: type: http scheme: bearer ````