Skip to content
ReputeCastReputeCast Docs

Import the staged rows

POST
/api/v1/workspaces/{workspace}/imports/{id}/start
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/start \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:import

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
connection
object
account
required
string
baseUrl
string
checkedAt
required
string format: date-time
dataCenter
string
lists
required
Array<object>
object
cleaned
required

Hard bounced in the source

integer format: int64
complained
required
integer format: int64
doubleOptIn
required
boolean
fields
required
integer format: int64
id
required
string
name
required
string
pending
required
integer format: int64
since
string
subscribed
required
integer format: int64
tagExamples
required
Array<string>
tags
required
integer format: int64
transactional
required
integer format: int64
unsubscribed
required
integer format: int64
templates
object
saved
required
integer format: int64
skipped
required
integer format: int64
transactional
required
integer format: int64
createdAt
required
string format: date-time
createdBy
required
string
error
object
badRows
Array<object>
object
columns
required
integer format: int64
line
required
integer format: int64
raw
required
string
code
required

Source_auth_failed, source_rate_limited, source_unavailable, file_columns, file_unreadable

string
header
integer format: int64
message
required
string
retryAt
string format: date-time
row
integer format: int64
status

HTTP status from the source (401, 429)

integer format: int64
fieldCount
required
integer format: int64
fileName
required
string
finishedAt
string format: date-time
hasCredentials
required

An API key is stored (it is never returned)

boolean
id
required
string
log
required
Array<object>
object
at
required
string format: date-time
kind
required
string
Allowed values: start running done sync retry error info
message
required
string
options
required
object
evidence
required
string
Allowed values: trust repermission
importEngagement
required
boolean
importTags
required
boolean
importTemplates
required
boolean
lists
required
Array<object>
object
sourceId
required
string
target
required

List id, or new:

string
onConflict
required
string
Allowed values: fill overwrite keep
pace
integer format: int64
<= 50
pullSuppressions
required
boolean
recordHistory
required
boolean
risky
required
object
abuse
string
Allowed values: import skip ""
catch_all
string
Allowed values: import skip ""
disposable
required
string
Allowed values: skip import
role
required
string
Allowed values: exclude_broadcasts skip import
stale
required
string
Allowed values: pending skip import
trap
required
string
Allowed values: skip import
typo
required
string
Allowed values: fix skip import
unknown
string
Allowed values: import skip ""
skipRows
required
Array<integer>
previous
object
contacts
required

Contacts imported, merged or imported as pending

integer format: int64
createdAt
required
string format: date-time
createdBy
required
string
fileName
required
string
finishedAt
string format: date-time
id
required
string
source
required
string
sourceName
required
string
status
required
string
step
required
string
progress
required
object
batch
required
integer format: int64
batchSize
required
integer format: int64
batches
required
integer format: int64
imported
required
integer format: int64
merged
required
integer format: int64
pending
required
integer format: int64
processed
required
integer format: int64
skipped
required
integer format: int64
suppressed
required
integer format: int64
total
required
integer format: int64
providerSync
required
Array<object>
object
name
required
string
pulled
required
integer format: int64
short
required
string
source
required
string
sourceName
required
string
stagedAt
string format: date-time
stagedRows
required
integer format: int64
startedAt
string format: date-time
stats
object
confirmsSent
required

Re-permission emails sent through the System stream

integer format: int64
durationMs
required
integer format: int64
imported
required
integer format: int64
lists
required
Array<object>
object
contacts
required
integer format: int64
name
required
string
merged
required
integer format: int64
pending
required
integer format: int64
pushedTo
required

Providers the new suppressions were pushed to

Array<string>
reasons
required
object
key
additional properties
integer format: int64
rows
required
integer format: int64
skipped
required
integer format: int64
suppressed
required
integer format: int64
suppressedBy
required

Unsubscribe, hard_bounce, complaint

object
key
additional properties
integer format: int64
templates
object
manual
required
integer format: int64
saved
required

Marketing and other templates added to the saved templates

integer format: int64
skipped
required
integer format: int64
transactional
required

Transactional templates imported as drafts

integer format: int64
texts
object
key
additional properties
integer format: int64
status
required
string
Allowed values: draft staging mapping previewing running paused done failed cancelled
step
required
string
Allowed values: source fields consent preview import done

Example 

{
  "log": [
    {
      "kind": "start"
    }
  ],
  "options": {
    "evidence": "trust",
    "onConflict": "fill",
    "risky": {
      "abuse": "import",
      "catch_all": "import",
      "disposable": "skip",
      "role": "exclude_broadcasts",
      "stale": "pending",
      "trap": "skip",
      "typo": "fix",
      "unknown": "import"
    }
  },
  "status": "draft",
  "step": "source"
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0