Reports

Update Report

Changed on

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

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/reports/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The ID of the report to update.

Request body

sqlQuerystring

The SQL query defining the report.

descriptionstring nullable

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

metadataobject nullable

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

Response

The updated Report object.

idstring required

Unique identifier for the report.

object'report' required

Always report.

liveboolean required

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

sqlQuerystring required

The SQL query defining the report.

descriptionstring

An optional user-friendly description for the report.

metadataobject

Optional key-value metadata associated with the report.

createdAtstring date-time required

Timestamp when the report was created.

updatedAtstring date-time required

Timestamp when the report was last updated.

Changes

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new not_found_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status