/v1/import

post

https://api.apptoto.com/v1/import

Imports can be kicked off by uploading a CSV file to https://api.apptoto.com/v1/import

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

POST /v1/import kicks off an Import based on the data you pass in. You can use GET /v1/import to fetch the Import information using the id provided to find out the result of the import.

Example Result:

{
  "import": {
    "id": NUMERIC IDENTIFIER,
    "state": launching | running | invalid | finished | aborted
  }
}

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the imports:write scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.

Form Data

data

file

required

The CSV or Tab-delimited file that Apptoto should import. This parameter can either a string, or a file (using multipart/form-data)

based_on_import_id

int32

Instead of providing a "spec" parameter, you can use Apptoto's Import UI to map columns to fields. Once you've done that you can specify the import id of the existing import for the based_on_import_id parameter and Apptoto will use the settings from that previous import when running the new uploaded import.

target

string

Defaults to events

Can be either "events" or "contacts". Defaults to "events".

start_time

date

Required when using the "support_delete" option. This tells Apptoto the beginning of the time range of appointments that you are uploading. Any appointments that are inside the time range but not included in the new upload will be removed if support_delete is turned on.

end_time

date

Required when using the "support_delete" option. See start_time parameter above for more information.

support_delete

boolean

Supports removing any appointments on the server that are not listed in the upload between the start_time and end_time provided. This is often set in the upload spec already, but you can override it here.

support_update

boolean

Supports updating any appointments on the server that are not listed in the upload between the start_time and end_time provided. This is often set in the upload spec already, but you can override it here.