SPsponsorunited
Custom Reports

Rename a custom report

Updates the title of a custom report. User must be the owner. If the new title conflicts with an existing report, it will be automatically adjusted with a numeric suffix.

patch/api/custom-reports/{id}/rename

Request

Path parameters

idinteger required

The unique identifier of the custom report to rename

Request body

titlestring required

New report title

Response

Custom report renamed successfully

idinteger
titlestring
descriptionstring nullable
report_file_idinteger nullable
thumbnail_urlstring nullable
published_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
sent_countinteger

Number of users this report was shared with

opened_countinteger

Number of recipients who have viewed the report

Example response

{
  "file": {
    "user_id": 1,
    "original_name": "document.pdf",
    "stored_name": "2023_01_document.pdf",
    "mime_type": "application/pdf",
    "file_size": 2048,
    "file_hash": "5fghjk234ghj234gj234g234",
    "url": "https://example.com/files/2023_01_document.pdf",
    "thumbnail_id": 2
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.