Import

An operation that imports data into Outreach

createdAt
string <date-time>

The date and time the import was created.

dupeMethod
string <= 255 characters

The type of deduplication strategy, skip, missing or overwrite.

dupes
integer

The number of dupes for the import.

errorReason
string <= 65535 characters

The reason for the failure of an import.

externalId
string <= 255 characters

The ID of a Report in a CRM for ReportImport (is not related to external/external_input_payload)

externalName
string <= 255 characters

The name of a Report in a CRM for ReportImport (is not related to external/external_input_payload)

externalType
string <= 255 characters

The Type of a Report in a CRM for ReportImport (is not related to external/external_input_payload)

failures
integer

The total number of failures associated with this import.

fileName
string <= 255 characters

The file name for the import.

fileSize
integer

The size of the file for the import

frequency
string <= 255 characters

The frequency an import will recur on (once, hourly, daily)

importType
string <= 255 characters

The type of import.

loadFromPlugin
boolean

Indicates if the import leverages load_from_crm or is a ReportImport

mappings
object

The mapping of rows to properties of the item.

pluginId
integer

The ID of the Outreach Plugin powering the load_from_crm or ReportImport functionality

prospectOwnerId
integer

Owner ID to override during import (applies to prospects, accounts, and opportunities)

recurring
boolean

Whether or not the import is a recurring import

reportInstanceId
string <= 255 characters

The ID of the salesforce report import

scheduledAt
string <date-time>

The next scheduled run for a recurring import

source
string <= 255 characters

Source to override during prospect import

stageId
integer

Stage ID to override to during import

state
string <= 255 characters

The state of the import.

stateChangedAt
string <date-time>

Indicates the last mutation to the state field

syncedUntil
string <date-time>

The point in time this report is synced to

timeZone
string <= 255 characters

TimeZone to override during prospect import

total
integer

The total number of items associated with this import.

updatedAt
string <date-time>

The date and time the import was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "dupeMethod": "string",
  • "dupes": 0,
  • "errorReason": "string",
  • "externalId": "string",
  • "externalName": "string",
  • "externalType": "string",
  • "failures": 0,
  • "fileName": "string",
  • "fileSize": 0,
  • "frequency": "string",
  • "importType": "string",
  • "loadFromPlugin": true,
  • "mappings": { },
  • "pluginId": 0,
  • "prospectOwnerId": 0,
  • "recurring": true,
  • "reportInstanceId": "string",
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "stageId": 0,
  • "state": "string",
  • "stateChangedAt": "2019-08-24T14:15:22Z",
  • "syncedUntil": "2019-08-24T14:15:22Z",
  • "timeZone": "string",
  • "total": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Import Relationships

(user (data (object) or links (object)))
{
  • "creator": {
    }
}

Import Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta

⌵ Import Actions

Get an Import by ID

SecuritybearerAuth
Request
path Parameters
id
required
integer
Responses
200

OK

404

Not Found

get/imports/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Accounts Import
Import Action


This is the action to import an uploaded file into account's table.Accounts have customId as a unique field. If you upload a file with unique fields that already exist in Outreach database,the dupe method will be applied.


SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
object
 
type
string
 
Responses 
200
OK


422
JSON error message


post/imports/actions/accountsImport
Request samples 
application/vnd.api+json
{
  • "data": {
    },
  • "type": "string"
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Generate Upload Link
Upload Action


Generates a link, an URL at which the file should be uploaded, and a storage key, a reference for the upload


SecuritybearerAuth 
Responses 
200
OK


422
JSON error message


post/imports/actions/generateUploadLink
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Prospects Import
Import Action


This is the action to import an uploaded file into prospect's tableProspects have externalId as a unique field. If you upload a file with unique fields that already exist in Outreach database,the dupe method will be applied.


SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
object
 
type
string
 
Responses 
200
OK


422
JSON error message


post/imports/actions/prospectsImport
Request samples 
application/vnd.api+json
{
  • "data": {
    },
  • "type": "string"
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Validate Upload
Validate Upload Action


Validates the uploaded file


SecuritybearerAuth 
Request 
query Parameters
object
 
Responses 
200
OK


422
JSON error message


post/imports/actions/validateUpload
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}