Update File

curl -X PATCH https://app.withforerunner.com/api/v1/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalDocumentURL": "https://dms.example.com/docs/123"}'

{
  "file": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789"
  },
  "errors": []
}

endpoint

/api/v1/files/:id

Update metadata for an existing file in Forerunner.

Path Parameters

string

required

The unique identifier of the file to update

Body Parameters

string

required

A valid URL pointing to the document in an external system

Response

object

Contains the updated file metadata when successful, or null if the update fails.

Show properties

string

UUID uniquely identifying the file

array

Array of error objects. See Errors.

curl -X PATCH https://app.withforerunner.com/api/v1/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalDocumentURL": "https://dms.example.com/docs/123"}'

{
  "file": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789"
  },
  "errors": []
}

Get File

Overview

⌘I

Getting started

API reference

Integration

Path Parameters

Body Parameters

Response

​Path Parameters

​Body Parameters

​Response

Path Parameters

Body Parameters

Response