Objects

CardUploadForm

Fields

filestring (application/octet-stream)required
collectionstring
Default: "default"
tagsstring
Default: ""
forceboolean
Default: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Default: false
reviewboolean
Default: false
folder_idstring | null
Folder of the collection to put the new card in. A folder of another collection returns 400 folders.card_collection_mismatch, a missing folder returns 404 folders.not_found, and no COLLECTION_EDIT_CARDS permission on the folder returns 403 authz.forbidden. The check runs before the file is saved. A duplicate of a file that is already uploaded (skipped) is not moved into the folder.
length ≤ 64
collection_idinteger | null
Collection by ID. When collection is passed too, collection_id wins. A collection that does not exist in the organization or is not visible returns 404 collections.not_found.
external_idstring | null
external_id of the new card. With it, the card is created even if the collection already has the same file. If another card of the organization uses it, the request returns 409 cards.external_id_taken. To create or replace a card by external_id, use PUT /v1/cards-by-external-id/{external_id}.
length ≤ 512
metadatastring | null
metadata of the new card: a JSON object as the value of the form field. The rules are those of MetadataPatch.