Enable a file for public sharing | Sample

1 parameter · 1 body field

tokenstringoptional

Authentication token with the `files:write:user` scope.

Optional form data identifying the file to enable for public or external sharing.

filestringoptional

File to share

2 status codes

200Returns an object with `ok` set to true and the updated `file` object.

fileobjectrequired

okbooleanrequired

Allowed:true

defaultReturned when the file cannot be shared or the authentication token, permissions, or request arguments are invalid; the response includes `ok` set to false and an `error` reason.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:file_not_foundnot_allowednot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botuser_is_restrictedinvalid_arg_nameinvalid_array_arg

okbooleanrequired

Allowed:false

Error handling

The token must include the files:write:user scope. Supply file to identify the file to share, and use a valid authentication token when the header is provided.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.filesSharedPublicURL.create({ file: "example" });

{
  "ok": true
}

Request

Response

Errors