FIfinix
Files

Create an External Link

Changed on

Create an External Link to share with users so they can upload files directly from their browser. For more info, see Uploading files to Finix.

post/files/{file_id}/external_links

Request

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

OR
OR

Response

A single External Link

idstring

The ID of the External Link resource.

created_atstring date-time

Timestamp of when the object was created.

durationinteger nullable

Details how long (in minutes) the url is valid for.

expiredboolean

Whether the external link has expired.

expires_atstring date-time

When the external link expires.

file_idstring

The File ID the External Link relates to.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'UPLOAD' | 'DOWNLOAD' | 'VIEW'

Sets whether the link uploads or downloads files from Finix.

urlstring

The URL that can be used to upload, download, or view the File.

user_idstring

The ID of the user that requested to create this link.

Changes

  • fa256b901d16Revision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added to the request body anyOf list