v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Draft Form

Linking a Dataset to a Draft Form Attachment

(introduced: version 2022.3)

This endpoint can update a Form Attachment's link to a Dataset. You can use this to link or unlink a Dataset to a Form Attachment. Linking of a Dataset to the Attachment only happens if the Attachment type is file and there is a Dataset with the exact name of the Attachment (excluding extension .csv) in the Project. For example, if the Form definition includes an Attachment named people.csv, then it can be linked to a Dataset named people. Pay special attention to letter case and spaces.

When linking a Dataset, if there is any existing file attached then it will be removed.

patch/v1/projects/{projectId}/forms/{xmlFormId}/draft/attachments/{filename}

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

filenamestring required

The name of the attachment.

Response

OK

successboolean required

Example response

{
  "success": true
}