Apptoto Import API

openapi: 3.2.0
info:
  title: api-settings Import API
  version: '1.0'
servers:
- url: https://api.apptoto.com
security:
- sec0: []
- sec1: []
tags:
- name: Import
paths:
  /v1/import:
    post:
      summary: /v1/import
      description: Imports can be kicked off by uploading a CSV file to https://api.apptoto.com/v1/import
      operationId: import-upload
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: string
                  description: The CSV or Tab-delimited file that Apptoto should import.  This parameter can either a string, or a file (using multipart/form-data)
                  format: binary
                based_on_import_id:
                  type: integer
                  description: 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.
                  format: int32
                spec:
                  type: object
                  description: The spec JSON tells Apptoto how to interpret the uploaded file.  If you specify a based_on_import_id value, then this field is not required as Apptoto will use the "spec" used in that import.
                  properties: {}
                target:
                  type: string
                  description: Can be either "events" or "contacts".  Defaults to "events".
                  default: events
                start_time:
                  type: string
                  description: 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.
                  format: date
                end_time:
                  type: string
                  description: Required when using the "support_delete" option.  See start_time parameter above for more information.
                  format: date
                support_delete:
                  type: boolean
                  description: 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:
                  type: boolean
                  description: 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.
      deprecated: false
      security:
      - sec0: []
      - sec1:
        - imports:write
      tags:
      - Import
    get:
      summary: /v1/import
      description: ''
      operationId: v1import
      parameters:
      - name: id
        in: query
        description: The id of the import to fetch
        required: true
        schema:
          type: integer
          format: int32
      deprecated: false
      security:
      - sec0: []
      - sec1:
        - imports:read
      tags:
      - Import
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
    sec1:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.apptoto.com/oauth/authorize
          tokenUrl: https://api.apptoto.com/oauth/token
          refreshUrl: https://api.apptoto.com/oauth/token
          scopes:
            calendars:read: View calendars
            address_books:read: View address books
            contacts:read: View contacts
            contacts:write: Create, update, and delete contacts
            events:read: View calendar events
            events:write: Create, update, and delete events; mark event statuses
            bookings:read: View booking page availability and existing bookings
            bookings:write: Create bookings on booking pages
            imports:read: Check the status of imports
            imports:write: Upload imports (CSV / ICS / XML) that bulk-create data
            lists:read: View opt-in and opt-out lists
            lists:write: Modify opt-in and opt-out lists
            messaging:read: View conversations and message history
            messaging:send: Send SMS or email messages on the user's behalf
            webhooks:read: View webhooks
            webhooks:write: Create, update, and delete webhooks that send account activity to other services
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://apidocs.apptoto.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.apptoto.com/reference/import-upload.md
  - https://apidocs.apptoto.com/reference/v1address_books.md
  - https://apidocs.apptoto.com/reference/v1availability.md
  - https://apidocs.apptoto.com/reference/v1book_now-1.md
  - https://apidocs.apptoto.com/reference/v1booking_pages.md
  - https://apidocs.apptoto.com/reference/v1bookings.md
  - https://apidocs.apptoto.com/reference/v1calendars-1.md
  - https://apidocs.apptoto.com/reference/v1contact.md
  - https://apidocs.apptoto.com/reference/v1contacts-1.md
  - https://apidocs.apptoto.com/reference/v1contacts-2.md
  - https://apidocs.apptoto.com/reference/v1contacts-3.md
  - https://apidocs.apptoto.com/reference/v1contacts.md
  - https://apidocs.apptoto.com/reference/v1contactstag.md
  - https://apidocs.apptoto.com/reference/v1conversation_messages.md
  - https://apidocs.apptoto.com/reference/v1conversation_reply.md
  - https://apidocs.apptoto.com/reference/v1conversation_templates.md
  - https://apidocs.apptoto.com/reference/v1conversations.md
  - https://apidocs.apptoto.com/reference/v1event.md
  - https://apidocs.apptoto.com/reference/v1eventmark.md
  - https://apidocs.apptoto.com/reference/v1events-1.md
  - https://apidocs.apptoto.com/reference/v1events-2.md
  - https://apidocs.apptoto.com/reference/v1events-3.md
  - https://apidocs.apptoto.com/reference/v1events.md
  - https://apidocs.apptoto.com/reference/v1eventtag.md
  - https://apidocs.apptoto.com/reference/v1import.md
  - https://apidocs.apptoto.com/reference/v1lists-1.md
  - https://apidocs.apptoto.com/reference/v1lists-2.md
  - https://apidocs.apptoto.com/reference/v1lists-3.md
  - https://apidocs.apptoto.com/reference/v1lists.md
  - https://apidocs.apptoto.com/reference/v1participantmark.md
  - https://apidocs.apptoto.com/reference/v1participants-1.md
  - https://apidocs.apptoto.com/reference/v1participants-2.md
  - https://apidocs.apptoto.com/reference/v1participants-3.md
  - https://apidocs.apptoto.com/reference/v1participants.md
  - https://apidocs.apptoto.com/reference/v1participants_auto_messages-1.md
  - https://apidocs.apptoto.com/reference/v1participants_auto_messages.md
  - https://apidocs.apptoto.com/reference/v1participanttag.md
  - https://apidocs.apptoto.com/reference/v1start_conversation.md
  - https://apidocs.apptoto.com/reference/v1userinfo.md
  - https://apidocs.apptoto.com/reference/v1webhooks-1.md
  - https://apidocs.apptoto.com/reference/v1webhooks-2.md
  - https://apidocs.apptoto.com/reference/v1webhooks-3.md
  - https://apidocs.apptoto.com/reference/v1webhooks.md
  merge:
    pages: 43
    deduped: 84
    conflicts_kept_first: 0