Update Report

POST/print-mail/v1/reports/{id}

Update an existing saved report definition. You can change the query, description, or metadata.

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

description: optional string

An optional user-friendly description for the report. Set to null to remove.

metadata: optional map[string]

Optional key-value metadata associated with the report. Set to null to remove.

sqlQuery: optional string

The SQL query defining the report.

ReturnsExpand Collapse

Report object { id, createdAt, live, 5 more }

Represents a saved Report definition.

id: string

Unique identifier for the report.

createdAt: string

Timestamp when the report was created.

formatdate-time

live: boolean

Indicates if the report is associated with the live or test environment.

object: "report"

Always report.

sqlQuery: string

The SQL query defining the report.

updatedAt: string

Timestamp when the report was last updated.

formatdate-time

description: optional string

An optional user-friendly description for the report.

metadata: optional map[string]

Optional key-value metadata associated with the report.

Update Report

curl https://api.postgrid.com/print-mail/v1/reports/$ID \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY" \
    -d '{}'

{
  "id": "report_123",
  "object": "report",
  "live": false,
  "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
  "description": "Recent Orders",
  "metadata": {
    "team": "Sales"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}

Returns Examples

{
  "id": "report_123",
  "object": "report",
  "live": false,
  "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
  "description": "Recent Orders",
  "metadata": {
    "team": "Sales"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}