Create a New List
|
1 |
POST https://restapi.actonsoftware.com/api/1/list |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | false | required | String | Insert your generated access token. ("Bearer {access token}") |
| listname | form | false | required | string | Specify a unique name for the list. |
| foldername | form | false | optional | string | Specify the folder name to store the list. Lists are stored in the default folder by default. |
| headings | form | false | Optional | String | Does the first row of the source data contain a heading? ("Y","N") |
| fieldseparator | form | false | Optional | String | Set field separator character ("COMMA", "SEMICOLON" ) |
| quotecharacter | form | false | required | String | Set field quote character ("NONE", "SINGLE_QUOTE", "DOUBLE_QUOTE") |
| uploadspecs | form | false | required | String | A JSON formatted object to describe the structure of the list that is being created. |
| Body | false | optional | File | The file to upload (in CSV format). |
Parameter Notes
uploadspecs
Please see the uploadspecs page to learn how to format your uploadspecs.
Response
|
1 2 3 4 5 |
{ "status": "success", "message": "Upload completed", "jobId": "15959711" } |
Code Examples
cURlPython
|
1 |
curl -X POST https://restapi.actonsoftware.com/api/1/list -H 'Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'Content-Type: multipart/form-data' -F 'listname=Example' -F 'headings=Y' -F 'fieldseperator=COMMA' -F 'quotecharacter=NONE' -F 'uploadspecs=[{"columnHeading": "E-mail Address", "ignoreColumn": "N", "columnType": "EMAIL", "columnIndex": "0"}, {"columnHeading": "First Name", "ignoreColumn": "N", "columnType": "FIRSTNAME", "columnIndex": "1"}, {"columnHeading": "Last Name", "ignoreColumn": "N", "columnType": "LASTNAME", "columnIndex": "2"},{"columnHeading": "Company", "ignoreColumn": "N", "columnType": "COMPANY", "columnIndex": "3"}]' -F file=@/Users/john.doe/Documents/exampleList.csv |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
import requests url="https://restapi.actonsoftware.com/api/1/list" headers = { 'Authorization': "Bearer 12cd5289-7561-3f5d-81e5-fc956fa04d65", 'cache-control': "no-cache" } data = { 'listname':'API Test List 15','uploadspecs':'[{\"columnHeading\":\"Email\",\"ignoreColumn\":\"N\",\"columnType\":\"EMAIL\",\"columnIndex\":\"0\"},\n{\"columnHeading\":\"a1\",\"ignoreColumn\":\"N\",\"columnIndex\":\"1\"},\n{\"columnHeading\":\"A3\",\"ignoreColumn\":\"N\",\"columnIndex\":\"2\"}]','quotecharacter':'NONE','fieldseparator':'COMMA' } files = {'file':('Book1.csv', open('Book1.csv', 'rb'))} r = requests.post(url, data=data, headers=headers, files=files) print(r.content) |
