For the complete documentation index, see llms.txt. This page is also available as Markdown.

Import transactions into a transactional database.

Required permissions: Edit Contacts and transactions

post
Path parameters
transactionalDatabaseIDstring · uuidRequired
Query parameters
apiTokenstringRequired

API authentication token

Body
actionstring · enumOptionalPossible values:
columnDelimiterstringOptional
displayNamestringOptional
descriptionstringOptional
encodingstringOptional
firstRowHasColumnNamesbooleanOptional
rowSeparatorstringOptional
sourcestringOptional
textQualifierstringOptional
typestring · enumOptionalPossible values:
uploadIDstringOptional
hideImportbooleanOptional
importBlankValuesbooleanOptional
customTagsstring[]Optional
Responses
200

OK

application/json
importIDstringOptional
post/database/transactionaldatabases/{transactionalDatabaseID}/import/execute
POST /database/transactionaldatabases/{transactionalDatabaseID}/import/execute?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "lookupFieldMaps": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "action": "Append",
  "columnDelimiter": "text",
  "displayName": "text",
  "description": "text",
  "encoding": "text",
  "fieldMaps": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "firstRowHasColumnNames": true,
  "rowSeparator": "text",
  "source": "text",
  "textQualifier": "text",
  "type": "FlatFile",
  "updateMaps": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "uploadID": "text",
  "hideImport": true,
  "importBlankValues": true,
  "customTags": [
    "text"
  ]
}
{
  "importID": "text"
}

Last updated

Was this helpful?