CHchariot-giving
files

Upload a File

Upload a file with a given purpose to Chariot as multipart/form-data.

post/v1/files

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/files
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Request body multipart/form-data

filestring binary required

The file's bytes. At most 100 MiB.

purpose'manual_upload' | 'grant_letter' | 'integration_download' | 'inbound_mail_item' | 'inbound_mail_item_thumbnail' | 'inbound_email' | 'inbound_email_attachment' | 'bank_check_image_front' | 'bank_check_image_back' | 'check_attachment' | 'bank_statement' | 'bank_account_verification_letter' | 'automation_output' | 'export' | 'other' required

The file's purpose. Note that entries may be added to this list without notice.

descriptionstring

A description of the file.

Example request

{
  "purpose": "manual_upload",
  "description": "Donation receipt for donation to the nonprofit"
}

Response

The Idempotency-Key had already stored this file, so the existing File is returned and nothing was uploaded again.

idstring

The unique identifier for the file.

file_namestring

The name of the file.

descriptionstring nullable

The description of the file.

purpose'manual_upload' | 'grant_letter' | 'integration_download' | 'inbound_mail_item' | 'inbound_mail_item_thumbnail' | 'inbound_email' | 'inbound_email_attachment' | 'bank_check_image_front' | 'bank_check_image_back' | 'check_attachment' | 'bank_statement' | 'bank_account_verification_letter' | 'automation_output' | 'export' | 'other'

The file's purpose. Note that entries may be added to this list without notice.

content_typestring

The MIME type of the file.

size_bytesinteger

The size of the file in bytes.

created_atstring date-time

The date and time when the file was created.

updated_atstring date-time

The date and time when the file was last updated.

Example response

{
  "id": "file_01j8rs605a4gctmbm58d87mvsj",
  "file_name": "donation_receipt.pdf",
  "description": "Donation receipt for donation to the nonprofit",
  "purpose": "manual_upload",
  "content_type": "application/pdf",
  "size_bytes": 20841,
  "created_at": "2020-01-31T23:59:59Z",
  "updated_at": "2020-01-31T23:59:59Z"
}

Changes

No recorded changes to this operation across all 12 revisions of this API.