Update Record Attachments

API endpoint to update a record by uploading files to fields of the field type ‘Attachment ‘.

Note: This API documentation is intended to give the reader an overview of the APIs capabilities and how to access them. When trying to write API calls, we strongly recommend you use the API documentation directly associated with the specific API key you will be calling. That documentation includes examples with the actual IDs of the form and form elements, includes examples for each field available in the associated forms etc. This will allow direct copy-paste of the code snippets from the documentation into your code. If you were to try and use the examples in this documentation, you would have to modify them for the fields, form ID, etc.

HTTP request

PUT https://api.gwapps.com/v1/forms/formId/records/recordId/attachments

start

Note: This endpoint is exclusive to upload attachments to record with File Picker fields, only these fields can be updated through this endpoint.

Parameters

Parameter	Description	Type
Required path parameters
formId	The current formId 66b18359dc7659dc4cb98d15	string
recordId	The recordId	string
Optional query parameters
replaceAttachments	If query param is passed with value true will replace the existing attachments in the field data, otherwise will append the attachments to the current field data	boolean

start

Note: To upload the files, the HTTP request must be a multipart/form-data in order to send the files to the endpoint. Where the field names in the request are the field short codes and the value the attachments to upload

Request Body

Parameter	Description	Type
Required parameters
Field Short Code*	Each field in the form has a unique shortCode. You can find the Field Short Codes in form “Overview” section. You can also update your field Short Codes from the Field Properties in Form Designer.	* Only File Picker fields are supported. Refer to form “Overview”.

Example Request

PUT https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records/recordId/attachments

warning

Make sure to review the validation applied to the File Picker field in the form design, since this endpoint validates the file type and file size allowed in the field, if the fields to upload does not match validation the endpoint will return an array of errors for each file and the error message where the validation was not met.

Example Error Response

{
  "error": [
    {
      "fieldCode": "attachment1",
      "fileName": "file.zip",
      "mimeType": "application/zip",
      "message": "This file type is not supported."
    },
    {
      "fieldCode": "attachment1",
      "fileName": "file.md",
      "mimeType": "text/markdown",
      "message": "This file type is not supported."
    }
  ]
}

Response

The response returned will have the record information, where

Attribute	Description	Type
_id	The record ID	string
stage	The record’s stage	Stage
shortCode	Depends on field type	Each value is different depending on the field type

Example Response

{
  "kind": "form#record",
  "_id": "recordId",
  "meta": {
    "appId": "6266db8cbd86d9001a70c9ea",
    "formId": "66b18359dc7659dc4cb98d15"
  },
  "stage": {
    "id": "stg0",
    "status": "Draft"
  },
  "text1": "John",
  "number1": 10,
  "currency1": {
    "code": "USD",
    "value": 120
  }
}

Related API Articles

This article covers details for a specific API call/endpoint. Details of the overall Records API structure and calls/endpoints can be found in the GW Apps Records API article. Information on creating API Keys can be found within the API section of the Platform Settings, and in the Security > API Keys section of Edit App within each application.