Data upload type Custom list record
❗️ The file you use to upload the data must have a .csv extension in its filename.
1. The table must be in standard CSV format and use UTF-8 encoding.
The first row of the file must be a header row with the column names, followed by one or more rows of the actual data. You can prepare the CSV with a spreadsheet editor, text editor, or export it from your internal system if it supports exporting CSV.
2. All records in the document must correspond to the same data type
This means the entire document has data for type "Custom list record", i.e. it is a Custom list records table.
Currently we only allow one list’s records to be uploaded per one upload event, i.e. all rows must have the same list_code value.
3. All data fields (i.e. column names) must be in snake_case or camelCase.
Choose either snake_case or camelCase and stick with it for all data fields.
4. Make sure field “list_code” is present for every record/row
list_code - a unique code that each Custom list has. The list code is defined during the initial setup by the client.
5. Each row must correspond to one list record
Each row must correspond to one list record.
6. Data validation
Two factors are being validated when uploading custom list records:
Are the required fields present? (
list_code).Do the fields specified in the schema match the given data types (For example, schema specified that
dobis of typenumberbut the uploaded file hasdob -> "ABC").
7. Updating list records
There is no possibility to update list records using CSV data upload. With each CSV file upload new records are added to the list which is indicated in the file (list_code).
8. Example
Data upload type Custom list record relation
You can also upload Records' Complex fields via csv by selecting Custom list record relation in data upload. What fields fall under the Complex fields?
Multi field (e.g
bank_accounts: [123, 456])Object field (e.g
address: {city: 'Paris', street: 'Bonjour'})Multi Object field (e.g
shareholders: [{name:Bob,account:123},{name:Rob,account:456}])
The mandatory columns are:
list_code(the code of the Custom list),external_id(the external id of the Record),relation_type(the name of the Complex field).
Example:
