Skip to content
vocapable.Docs

Upload a CSV lead list for review

POST
/v1/workspace/imports
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "file_name": "example", "content": "example", "default_country": "US" }'

Stage the file and suggest a column mapping. Nothing is matched or created yet.

Uploading the identical file while an earlier copy is still under review opens that review (200) instead of starting a second one.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceLeadImportUpload

A CSV lead list read by the browser as text (at most 1 MB).

object
file_name
required
File Name
string
>= 1 characters <= 200 characters
content
required
Content
string
>= 1 characters <= 1100000 characters
default_country
Any of:
string
/^[A-Za-z]{2}$/

Responses

Section titled “Responses”

200

Section titled “200”

The identical file is already under review.

Media typeapplication/json
WorkspaceLeadImportDetail
object
id
required
Id
string
source
required
Source
string
Allowed values: csv form apollo hubspot salesforce integration
installation_id
required
Any of:
string
status
required
Status
string
Allowed values: uploaded validating review committing imported partially_failed rejected
file_name
required
Any of:
string
headers
required
Headers
Array<string>
mapping
required
Mapping
object
key
additional properties
string
sample_rows
required
Sample Rows
Array<Array<string>>
default_country
required
Any of:
string
fields
required
Fields
Array<object>
WorkspaceLeadFieldOption
object
key
required
Key
string
Allowed values: company contact_name first_name last_name title email phone website country external_id
label
required
Label
string
counts
required
WorkspaceLeadImportCounts

What the list holds and, after a commit, what happened. outreach_scheduled is always zero: an import never schedules outreach.

object
total
Total
integer
0
new
New
integer
0
existing
Existing
integer
0
ambiguous
Ambiguous
integer
0
suppressed
Suppressed
integer
0
invalid
Invalid
integer
0
awaiting_decision
Awaiting Decision
integer
0
to_create
To Create
integer
0
to_link
To Link
integer
0
to_skip
To Skip
integer
0
created
Created
integer
0
linked
Linked
integer
0
skipped
Skipped
integer
0
failed
Failed
integer
0
outreach_scheduled
Outreach Scheduled
integer
0
0
assign_to
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
created_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
acknowledged_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
acknowledged_at
required
Any of:
string format: date-time
committed_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
rows
required
Rows
Array<object>
WorkspaceLeadImportRow
object
id
required
Id
string
row_number
required
Row Number
integer
match_kind
required
Match Kind
string
Allowed values: new existing ambiguous suppressed invalid
underlying_kind
required
Any of:
string
Allowed values: new existing ambiguous suppressed invalid
suppressed
required
Suppressed
boolean
reason
required
Reason
string
decision
required
Decision
string
Allowed values: pending create link skip
result
required
Result
string
Allowed values: pending created linked skipped failed
error
required
Any of:
string
lead
required
WorkspaceLeadSummary
object
company
required
Any of:
string
name
required
Any of:
string
title
required
Any of:
string
email
required
Any of:
string
phone_e164
required
Any of:
string
website
required
Any of:
string
external_id
required
Any of:
string
warnings
required
Warnings
Array<string>
candidates
required
Candidates
Array<object>
WorkspaceLeadCandidate

An existing person (or business) the lead could be.

object
contact_id
required
Any of:
string
organization_id
required
Any of:
string
person_name
required
Any of:
string
organization_name
required
Any of:
string
signal
required
Signal
string
Allowed values: phone email name business
matched_contact_id
required
Any of:
string
matched_organization_id
required
Any of:
string
kept_owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
result_contact_id
required
Any of:
string
result_organization_id
required
Any of:
string
attempts
required
Attempts
integer
Example
{
  "source": "csv",
  "status": "uploaded",
  "fields": [
    {
      "key": "company"
    }
  ],
  "counts": {
    "total": 0,
    "new": 0,
    "existing": 0,
    "ambiguous": 0,
    "suppressed": 0,
    "invalid": 0,
    "awaiting_decision": 0,
    "to_create": 0,
    "to_link": 0,
    "to_skip": 0,
    "created": 0,
    "linked": 0,
    "skipped": 0,
    "failed": 0,
    "outreach_scheduled": 0
  },
  "rows": [
    {
      "match_kind": "new",
      "underlying_kind": "new",
      "decision": "pending",
      "result": "pending",
      "candidates": [
        {
          "signal": "phone"
        }
      ]
    }
  ]
}

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceLeadImportDetail
object
id
required
Id
string
source
required
Source
string
Allowed values: csv form apollo hubspot salesforce integration
installation_id
required
Any of:
string
status
required
Status
string
Allowed values: uploaded validating review committing imported partially_failed rejected
file_name
required
Any of:
string
headers
required
Headers
Array<string>
mapping
required
Mapping
object
key
additional properties
string
sample_rows
required
Sample Rows
Array<Array<string>>
default_country
required
Any of:
string
fields
required
Fields
Array<object>
WorkspaceLeadFieldOption
object
key
required
Key
string
Allowed values: company contact_name first_name last_name title email phone website country external_id
label
required
Label
string
counts
required
WorkspaceLeadImportCounts

What the list holds and, after a commit, what happened. outreach_scheduled is always zero: an import never schedules outreach.

object
total
Total
integer
0
new
New
integer
0
existing
Existing
integer
0
ambiguous
Ambiguous
integer
0
suppressed
Suppressed
integer
0
invalid
Invalid
integer
0
awaiting_decision
Awaiting Decision
integer
0
to_create
To Create
integer
0
to_link
To Link
integer
0
to_skip
To Skip
integer
0
created
Created
integer
0
linked
Linked
integer
0
skipped
Skipped
integer
0
failed
Failed
integer
0
outreach_scheduled
Outreach Scheduled
integer
0
0
assign_to
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
created_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
acknowledged_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
acknowledged_at
required
Any of:
string format: date-time
committed_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
rows
required
Rows
Array<object>
WorkspaceLeadImportRow
object
id
required
Id
string
row_number
required
Row Number
integer
match_kind
required
Match Kind
string
Allowed values: new existing ambiguous suppressed invalid
underlying_kind
required
Any of:
string
Allowed values: new existing ambiguous suppressed invalid
suppressed
required
Suppressed
boolean
reason
required
Reason
string
decision
required
Decision
string
Allowed values: pending create link skip
result
required
Result
string
Allowed values: pending created linked skipped failed
error
required
Any of:
string
lead
required
WorkspaceLeadSummary
object
company
required
Any of:
string
name
required
Any of:
string
title
required
Any of:
string
email
required
Any of:
string
phone_e164
required
Any of:
string
website
required
Any of:
string
external_id
required
Any of:
string
warnings
required
Warnings
Array<string>
candidates
required
Candidates
Array<object>
WorkspaceLeadCandidate

An existing person (or business) the lead could be.

object
contact_id
required
Any of:
string
organization_id
required
Any of:
string
person_name
required
Any of:
string
organization_name
required
Any of:
string
signal
required
Signal
string
Allowed values: phone email name business
matched_contact_id
required
Any of:
string
matched_organization_id
required
Any of:
string
kept_owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
result_contact_id
required
Any of:
string
result_organization_id
required
Any of:
string
attempts
required
Attempts
integer
Example
{
  "source": "csv",
  "status": "uploaded",
  "fields": [
    {
      "key": "company"
    }
  ],
  "counts": {
    "total": 0,
    "new": 0,
    "existing": 0,
    "ambiguous": 0,
    "suppressed": 0,
    "invalid": 0,
    "awaiting_decision": 0,
    "to_create": 0,
    "to_link": 0,
    "to_skip": 0,
    "created": 0,
    "linked": 0,
    "skipped": 0,
    "failed": 0,
    "outreach_scheduled": 0
  },
  "rows": [
    {
      "match_kind": "new",
      "underlying_kind": "new",
      "decision": "pending",
      "result": "pending",
      "candidates": [
        {
          "signal": "phone"
        }
      ]
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}