Skip to content
Vocapable Developers

Read an import job

GET
/v1/contact-imports/{import_id}
curl --request GET \
  --url https://api.vocapable.com/v1/contact-imports/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
import_id
required
Import Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ImportJob
object
id
required
Id
string
status
required
JobStatus

Lifecycle shared by the async import and export jobs.

string
Allowed values: queued running completed failed
file_uri
required
File Uri
string
column_mapping
Column Mapping
object
key
additional properties
string
target_list_id
Any of:
string
consent_attestation
required
ConsentAttestation

The stored attestation. signer_ip and signed_at are stamped by the API - a client-supplied timestamp is a claim, not evidence.

object
signer_name
required
Signer Name
string
>= 1 characters <= 200 characters
signer_title
required
Signer Title
string
>= 1 characters <= 200 characters
affirmation
required
Affirmation
string
>= 1 characters
consent_basis
required
ConsentBasis

CANON fact 18 - the four consent classes (docs/07-compliance.md §consent).

string
Allowed values: pewc pec ebr transactional
signer_ip
Any of:
string
signed_at
required
Signed At
string format: date-time
rows_accepted
required
Rows Accepted
integer
rows_rejected
required
Rows Rejected
integer
rows_skipped
Rows Skipped
integer
0
on_duplicate
On Duplicate
string
default: reject
Allowed values: reject skip update
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "status": "queued",
  "consent_attestation": {
    "consent_basis": "pewc"
  },
  "rows_skipped": 0,
  "on_duplicate": "reject"
}

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": {}
    }
  ]
}