Imports

Imports Documentation

Import [GET]

Creates a new Import associated with the Account List. This endpoint accepts a file to be uploaded using Content-Type "multipart/form-data", this makes the endpoint unique in that it does not only accept JSON content. Unless otherwise specified, the Import will be created with "in_preview" set to false, which will cause the import to begin after being created (the import runs asynchronously as a background job).

Request

Endpoint

GET /api/v2/account_lists/8839b785-bd5e-48d3-8e3c-11a94e8d402a/imports/9f0a424c-158e-449a-a1b1-a6ed37281cdc
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "9f0a424c-158e-449a-a1b1-a6ed37281cdc",
    "type": "imports",
    "attributes": {
      "account_list_id": "8839b785-bd5e-48d3-8e3c-11a94e8d402a",
      "created_at": "2022-01-12T17:18:26Z",
      "file_constants": {
      },
      "file_constants_mappings": {
      },
      "file_headers": {
      },
      "file_headers_mappings": {
      },
      "file_url": null,
      "group_tags": null,
      "groups": [

      ],
      "import_by_group": false,
      "in_preview": false,
      "override": false,
      "source": "twitter",
      "tag_list": null,
      "updated_at": "2022-01-12T17:18:26Z",
      "updated_in_db_at": "2022-01-12T17:18:26Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "177234d5-e152-47c6-a49a-a70328f95ac1",
          "type": "users"
        }
      },
      "sample_contacts": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

account_list_id

Type ID string

Description Account list that this import belongs to

created_at

Type date

Description The timestamp of when this resource was created

file_constants

Type object

Description Only applicable to CSV Import

file_constants_mappings

Type object

Description Only applicable to CSV Import

file_headers

Type object

Description Only applicable to CSV Import

file_headers_mappings

Type object

Description Only applicable to CSV Import

file_url

Type string

Description A URL to download the file

group_tags

Type string

Description Group Tags

groups

Type string

Description Groups

import_by_group

Type boolean

Description Import by Group

in_preview

Type boolean

Description If import is still waiting to be imported

override

Type boolean

Description If import should override local contacts when importing

source

Type string

Description source of the contacts to import

tag_list

Type string

Description Comma delimited list of Tags

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

sample_contacts.data

Type ["SampleContact"]

Description Collection of sample contacts based on data from the import for the user to validate import

user.data

Type User

Description User that initiated the import