/api/flatfile-integrations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Flat File API is designed to handle the following file types:

  1. XLSX
    1. When using an XLSX file, a table will be uploaded to Compyl for each Sheet. The tables will inherit the Sheet Names. For example, if you have a sheet named "Products", a [FlatFiles].[Products] table will be added to your Compyl environment.
  2. CSV
    1. When using a CSV file, a single table will be loaded to Compyl based on the FileName parameter passed via the Request Body.

🚧

Note

  • The operationType parameter requires quotation marks and is case sensitive: "Append" or "Replace"
  • First time uploads should always use "Replace"
Body Params
integer
required
Defaults to 0

Leave this set to 0

string

Optional description for your flat file

string
required

(Include the file extension) This field is used to track files uploaded to Compyl. If you upload a file with a file name that already exists, the Compyl API will perform an update operation.

string
required

A string representing the file you are uploading to Compyl and should be Base64 encoded.

string
required

Set to "Append" to add to existing values. Set to "Replace" to replace existing values.

Response
200
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!