startContactImport

Start importing contacts from a spreadsheet the person attached to the chat. Pass artifactId, the shelf id the chat names for the file ([shelf id …]). It creates the same upload the Import page creates (it shows on the Files page) and runs the import mapper on it, which takes up to a few minutes, then returns the import (its id is the fileProcessingTaskId every other contactImports operation takes), the file row count (totalRows) and its columns with example values (csvSample). Nothing is imported yet. transformerAuthoringState COMPLETED with hasAuthoredTransformer true means the mapping is ready: read it with previewContactImport. IN_PROGRESS means another mapping run on this upload is still going: wait a little and call authorContactImportMapping. Only .csv, .xlsx and .xls files can be imported (spreadsheets are stored as CSV). Call it once per file and keep the id; a second call for a file whose import is not confirmed yet returns that same import.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "startContactImport",
    "variables": {
      "artifactId": "<artifactId>"
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.contactImports.startContactImport(
  {
    artifactId: '<artifactId>'
  },
  { idempotencyKey: crypto.randomUUID() },
)

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'startContactImport',
    variables: {
      artifactId: '<artifactId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

artifactIdID!required

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "fileProcessingTaskMutation": {
      "startContactImportFromArtifact": {
        "id": "<ID>",
        "status": "CREATED",
        "transformerAuthoringState": "COMPLETED",
        "hasAuthoredTransformer": true,
        "totalRows": 0,
        "csvSample": [
          {
            "header": "…",
            "exampleData": [
              "…"
            ]
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

Variables

Response

Errors

Idempotency

Related