---
id: report-update
title: "Update a report"
description: "Partially updates a report's draft. Send only the fields you want to change."
sidebar_label: "Update a report"
hide_title: true
hide_table_of_contents: true
api: eJztWdtuGzkS/ZUC9yG7QEtWvHaS0WAfcvEgHmQ2Hl8mgzWMqNQsqTnuJjsk24pG6H9fFElJLVm+bJB5Wj9JapF1PVU81VwIj1MnhpfilGpjvRNXmZDkcqtqr4wWQ3GC1issyzk0tURPDhBsWPzMgbQ48X04Iy3B6HIOviCYKCqlg7lpYIbagzeQF6in1BeZMDVZZNHHUgxFFDSMkkUmarRYkSfLNi2EYgNq9IXIhMaKxFAoKTJh6UujLEkx9LahTLi8oArFcCH8vOZVzlulpyITE2Mr9GIomkZJ0W47d14QNFp9aQiUJO3VRJEFMwl+ROPYaPqKVV2y4Mnk8IeXg/Gkd/jDvuwd4CvZG786fNX75/OXh5QfHBwcvtgX7VU0kZx/Y+Sc7cqN9qQ9f8W6LlUeYrD3h2MzFl0HlA+KYj4uloFJfpnxH5R7kQmUUrEELE8sh9QrcmI4wdLRto8fl3mprblRkuQyQWgp5VSyk3VH0CKF+3ZAb8dvDQbl6hLnwFs3o/aO6tLMK9IeJiEwOp9zMlzZTB9W8houTj/0JlaRluW8m6iJsXdmSq509jZ0bsh+WHXRVKh7llDiuCTo/M0wmRXoOxaAK8zM3eW7g5osdNKfhQczousQjG0QP5DsCP1te38++/hvOAuiQNJEaaWnHQufOVC6bnzCQJ8VN+rz99F9cbzUzHC3pixZeWFmsS0YW4ElLclGvV8asgltS9T/mh7dBvy2rgprTgDLmMPxO8ddJv6IXvNC14cjzAs4fgeK2xYDM7SlvDDGEW9JYIoFEvfPlC+U3sLV7jBsGj5/t9K8w4F1z7oUzjQ2J+6199bxZkWmTY+qybNfP8Do7OjD0dvzETiPnkLxrZ20DUfn2EOOGpTOy0YSjBYcoeH5vKZ2BHWJORWm5HyBD0DHa2IZysINlg05mFhTxcRGPGWADiTlJVqSoDSMQkd3o82aiJbFfPx0+vEXIH2jrNGxSj69Pzo9Asxz02gP/4JF+jo8Cw63jJ0odhdgN4PxRmnpYvfrusOWxXiOGAUdDxJkrmkOFfq8COddZ280OuEjxPJeeNwHgtzU/zMGwp5HtK3QBk6M0p4se7gqwOBlTKdruBXRrfA8czG9mzn7297alL2UEdG2bZsJj3ZK/lvNir0HknSuROUSSmtTN2XgHFyUoLwDS64pvbvHtg6WGCkV1jUbs8M60k3FmQift4jPezNbFkvUGXuOTmaPotejGNE+XDiCEUsKiPKNXbaQuFct94Xlzxw4Kin34VAxdexWGz4Fo2J8b5RTY1UqP++2nN/WT7M7XWscWWZddopa/RlOnduefipM6AOOqNv2YMS7R3BNVDtQHmqrbtDHvukdmJkm+yOMusJH4Aq0FJaHnLG8WWHYy86yTVeDkW0bnXWUNza4erkQY0JL9nXjCzG8vIq8ytVGu1gO+4MBf+zgdJHWdBr4NxKwHY18syKVfJh23sM6E29Yc5pvoZvZE1v7XmyNi95MPGkgPgY6UIFoonuiak9U7YmqPVG1J6r2RNX+X6laJnJLTLA+404sregPs7CeVxXtbH3HZx/h1YvBc+AVzmNVx1Oaui0dZuggqdu0ZX+w/6I3eNnbH5w/3x8OBsPB4D/hkIzk76+wbeN0LtH5xDQfY1jitwe//36bs74tFTd9stZYWFFckE3MoL7BUslEB4yFSjnH5/X6dek3UdwjVvfQ+efRN+6tkRwmShsqcg6noSNuNb316nXouYVMA7a3qvb8/ATiDsiN5FYtg9GJBgVtG5E9GAwYe5vi7+xgFeaF0rSmgzG8QVXoqjl6mhqr/kyNdYKqbOxWMscoP6eXuQyuGIJHaHeFsT7bZqTRBN67qeUNSjhda1kG+GE9qwMJJHlUpQMcm8bfEcA0AgQ9obAqLLkgSEKIjPaodKADEXFdgC0BfLgLwMd8TLAVjuwN2eRnwi9qaDR9rSnnmUw5Fw+sJ7w+4fUvx2swzhdGxpukvAi3TPw+QezFTr63ULIV/OKBkRsvnhpbiqEovK/dcG8Pa9XXTVnWJXrW3s9NFS55lu8qwigVEdV9Y7EKBgsSaWwMOQqLRJa+/LQ8kn7+dC7YYi6B0/UF0tEyHMtrmd0j+nJC3z1Mb2ficfcSnVl3a/zcmAq3mM+KJig9MbdfqvDQyKGOhgz6z/uDW+b9ghqnBHKusVJ5OnTdkLnYpLdOfHoO40aVPs44uDFYc74ywPXAmwFqyVNXb4z5NUlIXvQhGQcF3hBgvNuMhceDKEnlw1ZVVU0kg3UzLpUrSELyxi3Zup1gHkaPY+3UtPBxiq6N8xXqTh7j/d7qRnU7Cp17w+99D5uQ6emr36tLVDowJ4b9ItXHpVgZNVSSe2dhnOfni8UYHV3Ysm35cWDe/H4uEzdoFYcmFJFUjr/L3feSXd/+fpo6+D/gkTeyO81PD1Ez2sNcJIZCZOKa5vHmuL1qM1EQSrLBwvjH22hHj4fpzsZbZ1KbLXe8znOq/b1rrzp95+T1+dv3XO3pMrgKB4KwOOPDC2fRyjRa8ILwbCFK1NMmtFURhXJvwM3WstVKgls747BYxBXn5pp0267C4vk3R6Zt/wsgujgz
sidebar_class_name: "patch api-method"
info_path: docs/api/reports
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a report"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/report/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Partially updates a report's draft. Send only the fields you want to change.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"},"description":"The unique identifier of the report.","example":"ff5970bf-592d-4a8d-b858-3175ec444562"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"title":"ReportUpdate","type":"object","additionalProperties":false,"description":"Only the provided fields are updated.","properties":{"name":{"type":"string","description":"The report's display name.","example":"Deployment frequency"},"slug":{"type":"string","description":"A URL-friendly identifier for the report.","example":"deployment-frequency"},"description":{"type":"string","description":"A human-readable description of what the report shows.","example":"Deployments per application, per week"},"schema":{"type":"object","additionalProperties":true,"description":"A JSON Schema defining the report's input fields."},"ui_schema":{"type":"object","additionalProperties":true,"description":"A UI Schema controlling how the form renders."},"queries":{"title":"Queries","type":"object","description":"A map of query IDs to query definitions. Each ID is a name you choose to identify the query within the report.","additionalProperties":{"title":"QueryDefinition","type":"object","required":["source"],"additionalProperties":false,"properties":{"source":{"type":"string","description":"The SQL `SELECT` statement the query runs. It can include `{name:Type}` placeholders that take their values from form fields, as declared in `params`.","example":"SELECT name FROM environments WHERE account = {account:String}"},"params":{"type":"object","description":"Binds the placeholders in `source` to form fields. Each key matches a placeholder name in the query.","additionalProperties":{"type":"object","required":["scope"],"additionalProperties":false,"properties":{"scope":{"type":"string","description":"A JSON Pointer to the form field that supplies the placeholder's value.","example":"#/properties/account"}}}},"target":{"type":"string","description":"A JSON Pointer to the schema property this query populates with its results.","example":"#/properties/environment"},"mapping":{"type":"string","enum":["enum"],"description":"How query results map onto the `target` field. Use `enum` to turn the results into the field's selectable options.","example":"enum"}}}},"visibility":{"title":"Visibility","type":"string","enum":["user","organization"],"description":"Who can see the report. `user` keeps it private to its owner; `organization` shares it with the whole organization.","example":"user"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The updated report.","content":{"application/json":{"schema":{"title":"Report","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique report identifier.","example":"ff5970bf-592d-4a8d-b858-3175ec444562"},"name":{"type":"string","description":"The report's display name.","example":"Deployment frequency"},"slug":{"type":"string","description":"A URL-friendly identifier for the report.","example":"deployment-frequency"},"description":{"type":"string","description":"A human-readable description of what the report shows.","example":"How often each application deploys"},"schema":{"type":"object","additionalProperties":true,"description":"A JSON Schema defining the report's input fields."},"ui_schema":{"type":"object","additionalProperties":true,"description":"A UI Schema controlling how the form renders."},"queries":{"title":"Queries","type":"object","description":"A map of query IDs to query definitions. Each ID is a name you choose to identify the query within the report.","additionalProperties":{"title":"QueryDefinition","type":"object","required":["source"],"additionalProperties":false,"properties":{"source":{"type":"string","description":"The SQL `SELECT` statement the query runs. It can include `{name:Type}` placeholders that take their values from form fields, as declared in `params`.","example":"SELECT name FROM environments WHERE account = {account:String}"},"params":{"type":"object","description":"Binds the placeholders in `source` to form fields. Each key matches a placeholder name in the query.","additionalProperties":{"type":"object","required":["scope"],"additionalProperties":false,"properties":{"scope":{"type":"string","description":"A JSON Pointer to the form field that supplies the placeholder's value.","example":"#/properties/account"}}}},"target":{"type":"string","description":"A JSON Pointer to the schema property this query populates with its results.","example":"#/properties/environment"},"mapping":{"type":"string","enum":["enum"],"description":"How query results map onto the `target` field. Use `enum` to turn the results into the field's selectable options.","example":"enum"}}}},"visibility":{"title":"Visibility","type":"string","enum":["user","organization"],"description":"Who can see the report. `user` keeps it private to its owner; `organization` shares it with the whole organization.","example":"user"},"created_at":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of when the report was created.","example":"2026-07-20T12:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of the report's last update.","example":"2026-07-20T12:00:00Z"}}}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"title":"Error","type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code indicating the error.","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the failure.","example":"bad_request"},"error":{"type":"string","description":"A short, human-readable error type.","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Internal server error due to an unexpected issue.","content":{"application/json":{"schema":{"title":"Error","type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code indicating the error.","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the failure.","example":"bad_request"},"error":{"type":"string","description":"A short, human-readable error type.","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}}}}
>
  
</StatusCodes>