absenceRegions11

absences5

accounts2

agentFiles2

agentRuntime10

agentSchedules10

agentSkills20

agentThreadFiles2

agentThreads7

apiUsers5

assignedTasks8

autopilot6

checklistItems16

clientApplications11

companies11

companyFiles16

companyTags6

customAgents16

customFields23

dashboards1

documentComments8

documentFiles15

documents23

documentSpaces11

files2

fileUpload2

filters20

images24

invitations3

permissions3

privateTasks10

projectActivities1

projectAutomations13

projectComments7

projectFiles18

projectMembers2

projectMilestones6

projectMilestoneTemplates5

projectRoles8

projects13

projectStatuses7

projectTags6

projectTasks6

projectTemplateAutomations12

projectTemplateFiles17

projectTemplates14

projectTemplateTags6

projectTypes7

retainers5

roles17

search1

sharedFiles2

taskActivities1

taskBundles29

taskComments7

taskDependencies4

taskDependencyTemplates5

taskFiles17

taskLists13

tasks21

taskSchedules6

taskStatuses5

taskTags9

taskTemplateFiles17

taskTemplates7

taskTemplateTags6

teams9

temporaryFiles6

timeBookings10

timeEntries18

timeReports1

timeTracking8

timeTrackingSettings1

typeOfWork7

userCapacities2

userFiles17

users15

userTags6

webhooks8

workflowAutomations12

workflows21

workload1

workspaceAbsences4

workspaceFiles17

workspaces3

documentFiles

Creates external file references for the specified document.

Changed on Sep 20, 2026

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/documents/{documentId}/externalfiles

Request

Base URL: https://api.awork.com/api/v1
URL: https://api.awork.com/api/v1/documents/{documentId}/externalfiles
Auth: HTTP bearer

Path parameters

documentIdstring uuid required

Request body

namestring required

The name of the file.

descriptionstring nullable

The description of the file.

externalProviderstring required

The external provider for the file. Like 'google' or 'onedrive'.

externalFileUrlstring required

The file url of the external provider.

mimeTypestring nullable

The mime type if the external file.

Response

namestring nullable

The user-specified name of the file.

descriptionstring nullable

The description of the file.

idstring uuid

The id of the file info.

entityIdstring uuid nullable

Deprecated. The id of the linked entity derived from entity specific owner ids.

projectIdstring uuid nullable

projectTemplateIdstring uuid nullable

companyIdstring uuid nullable

taskIdstring uuid nullable

taskTemplateIdstring uuid nullable

userIdstring uuid nullable

documentIdstring uuid nullable

fileNamestring nullable

The name of the file.

entityTypestring nullable

The name of the linked entity type.

mimeTypestring nullable

The MIME type of the file.

createdOnstring date-time

The date this file was created.

createdBystring uuid

The id of the user who created this file.

updatedOnstring date-time

The date this file was last modified.

updatedBystring uuid

The id of the user who last modified this file.

isCommentFileboolean

Whether the file is related to a comment.

externalProviderstring nullable

The external provider for the file. Like 'google' or 'onedrive'.

externalFileUrlstring nullable

The file url of the external provider.

isHiddenForConnectUsersboolean

Whether the file is hidden for connect users.

Changes

Sep 20, 20265332322ffca3 Revision changes
- breaking
  the response's body type changed from object to array for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id documentFiles_CreateExternalFiles removed and replaced with documentFiles_PostExternalFilesByDocumentNameAndDocumentId
- info
  added the non-success response with the status
- info
  added the non-success response with the status
Sep 17, 20261556e0487867 Revision changes
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security oauth2 was added to the API

Operation history (4 revisions)