Skip to main content
PATCH
/
v1
/
files
/
{id}
PHP (SDK)
declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$filePatch = new Components\FilePatch();

$response = $sdk->files->update(
    id: '<value>',
    filePatch: $filePatch

);

if ($response->responseFilesUpdate !== null) {
    // handle response
}
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "path": "<string>",
  "mime_type": "<string>",
  "size": 123,
  "storage_version": "<string>",
  "checksum_etag": "<string>",
  "checksum_sha256_base64": "<string>",
  "checksum_sha256_hex": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "version": "<string>",
  "service": "<string>",
  "is_uploaded": true,
  "created_at": "2023-11-07T05:31:56Z",
  "size_readable": "<string>"
}

Authorizations

Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

id
string<uuid4>
required

The file ID.

Body

application/json
name
string | null
version
string | null

Response

File updated.

File to be associated with the downloadables benefit.

id
string<uuid4>
required

The ID of the object.

organization_id
string<uuid4>
required
name
string
required
path
string
required
mime_type
string
required
size
integer
required
storage_version
string | null
required
checksum_etag
string | null
required
checksum_sha256_base64
string | null
required
checksum_sha256_hex
string | null
required
last_modified_at
string<date-time> | null
required
version
string | null
required
service
string
required
Allowed value: "downloadable"
is_uploaded
boolean
required
created_at
string<date-time>
required
size_readable
string
required