CreateDescriptionAttachmentRequest

A request or response body; the type column links to the schemas it refers to.

CreateDescriptionAttachmentRequest

FieldTypeRequiredDescription
pathnamestringyes

The pathname an upload ticket was issued for, after PUTting the file.

at least 1 character

file_namestringyes

1–300 characters

labelstringno

Omit or send empty to show the file name instead.

at most 200 characters

prefer_inline_displaybooleanno

Omit to show the file on the page where its type allows it. Send false for a file meant to be downloaded and worked on locally — a blank form, a spreadsheet — so it renders as a download instead of an inline viewer.

jsonExample
{
  "pathname": "string",
  "file_name": "string",
  "label": "string",
  "prefer_inline_display": true
}