SPsponsorunited
Partnership Reports

Update a partnership report

Updates an existing partnership report by its ID with the provided data.

put/api/reports/partnership/{id}

Request

Path parameters

idinteger required

The unique identifier of the partnership report to update

Request body

titlestring
descriptionstring
report_file_idinteger
report_external_urlstring
thumbnail_urlstring
resized_urlstring
original_urlstring
published_atstring
brandsinteger[]
propertiesinteger[]
agenciesinteger[]

Example request

{
  "title": "Partnership Report Title",
  "description": "Partnership Report Description",
  "report_external_url": "https://www.example.com",
  "thumbnail_url": "https://www.example.com",
  "resized_url": "https://www.example.com",
  "original_url": "https://www.example.com",
  "published_at": "2021-01-01"
}

Response

Partnership report successfully updated

idinteger
titlestring
descriptionstring
report_external_urlstring
thumbnail_urlstring
resized_urlstring
original_urlstring
published_atstring date-time

Example response

{
  "file": {
    "id": 1,
    "original_name": "document.pdf",
    "stored_name": "202101_document.pdf",
    "mime_type": "application/pdf",
    "file_size": 204800,
    "file_hash": "abcdef123456",
    "url": "https://example.com/files/document.pdf",
    "user": {
      "id": 1,
      "name": "John Doe"
    },
    "thumbnail": {
      "id": 2,
      "original_url": "https://example.com/thumbnails/original.png",
      "image_url": "https://example.com/thumbnails/image.png",
      "resized_image_url": "https://example.com/thumbnails/resized.png",
      "extension": "png",
      "mime_type": "image/png",
      "file_size": 10240,
      "width": 100,
      "height": 100
    }
  }
}

Changes

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