attachment

post/api/v1/attachment/{id}/to_document/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (scopes: write:attachment)
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this Attachment.

Query parameters

format'csv' | 'json'

Request body

resource_uristring uri required
idinteger required
belongs_tostring uri required
namestring required
filetypestring
sizeinteger nullable
site_urlstring required
anchor_urlstring required
file_urlstring required
pendingboolean
is_convertedboolean
convertedstring uri required
approvedboolean
can_approveboolean
can_change_approvalstring required
redactedstring uri required
is_redactedboolean
can_redactstring required
can_deletestring required
is_pdfstring required
is_imagestring required
is_irrelevantstring required

Response

resource_uristring uri required
idinteger required
site_urlstring required
titlestring
slugstring required
descriptionstring
published_atstring date-time nullable required
num_pagesinteger required
publicboolean required
listedboolean required
allow_annotationboolean required
pendingboolean required
file_urlstring required
file_sizeinteger nullable required
cover_imagestring required
page_templatestring required
outlinestring required
propertiesunknown required
uidstring uuid required
dataunknown required
pages_uristring required
originalstring uri required
foirequeststring uri required
publicbodystring uri required
last_modified_atstring required

Changes