2023-04-17 23:17:45 -05:00
|
|
|
# Add File {% #add-file %}
|
2023-04-19 22:08:04 -05:00
|
|
|
|
2023-04-19 22:09:04 -05:00
|
|
|
This endpoint allows you to add a file to a record. The request body must be of type `multipart/form-data`.
|
|
|
|
|
|
2023-04-19 22:08:04 -05:00
|
|
|
## Request Body Properties
|
|
|
|
|
|
|
|
|
|
{% table %}
|
|
|
|
|
|
|
|
|
|
- Property Name
|
|
|
|
|
- Data Type
|
|
|
|
|
- Description
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- recordId
|
|
|
|
|
- `number`
|
|
|
|
|
- The id of the record to which the file will be added.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- fieldId
|
|
|
|
|
- `number`
|
|
|
|
|
- The id of the field to which the file will be added.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- notes
|
|
|
|
|
- `string`
|
|
|
|
|
- The notes to be added to the file.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- modifiedDate
|
|
|
|
|
- `string`
|
|
|
|
|
- The date the file was last modified.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- file
|
|
|
|
|
- `binary`
|
|
|
|
|
- The file to be added.
|
|
|
|
|
|
|
|
|
|
{% /table %}
|
|
|
|
|
|
|
|
|
|
## Response Body Properties
|
|
|
|
|
|
|
|
|
|
{% table %}
|
|
|
|
|
|
|
|
|
|
- Property Name
|
|
|
|
|
- Data Type
|
|
|
|
|
- Description
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- id
|
|
|
|
|
- `number`
|
|
|
|
|
- The id of the file that was added.
|
|
|
|
|
|
|
|
|
|
{% /table %}
|