Imports

Mutations

createImportJob

Create a new ImportJob

Arguments

• displayName (String) — The display name of the ImportJob
• flatfileSpace (FlatfileSpaceInput) — The Flatfile space to create the ImportJob for

Returns: CreateImportJobPayload!

Objects

CreateImportJobError

Fields

• code (CreateImportJobErrorCode!)
• human_readable_message (String!)

CreateImportJobFailure

Fields

• errors ([CreateImportJobError!]!)

CreateImportJobSuccess

Fields

• importJob (ImportJob!)

ImportJob

An ImportJob for a CSV import

Fields

• brand (Brand!) — The brand that the ImportJob is associated with
• cancelled_at (DateTime) — The date the ImportJob was cancelled
• completed_at (DateTime) — The date the ImportJob was completed
• created_at (DateTime!) — The date the ImportJob was created
• created_by_user (User) — The user that created the ImportJob
• display_name (String) — The display name of the ImportJob
• failed_at (DateTime) — The date the ImportJob failed
• flatfile_space (ImportJobFlatfileSpace) — The Flatfile space that the ImportJob is associated with
• flatfile_space_id (ID) — The ID of the Flatfile space that the ImportJob is associated with — 🚧 Deprecated: Use flatfile_space instead
• id (ID!) — The ID of the ImportJob
• idempotency_key (String) — The date the ImportJob was last updated, structured as string to be passed with managementUpdateImportJob mutations
• integration (Integration) — The integration that the ImportJob is associated with
• started_at (DateTime) — The date the ImportJob was started
• started_by_user (User) — The user that started the ImportJob
• status (ImportJobStatus!) — The status of the ImportJob
• type (ImportJobType) — The type of the ImportJob — 🚧 Deprecated: No longer used
• updated_at (DateTime!) — The date the ImportJob was last updated

ImportJobFlatfileSpace

A Flatfile space for a CSV import

Fields

• guest_link (String) — The guest link of the Flatfile space
• id (ID!) — The ID of the ImportJobFlatfileSpace

Unions

CreateImportJobPayload

Possible types

• CreateImportJobFailure
• CreateImportJobSuccess

Input Objects

FlatfileSpaceInput

Fields

• autoMappingEnabled (Boolean) — Whether to enable auto mapping for the Flatfile space
• importTag (String!) — The import tag to use for the Flatfile space
• name (String) — The name of the Flatfile space
• namespace (FlatfileSpaceNamespace!) — The namespace to use for the Flatfile space

Enums

CreateImportJobErrorCode

Values

• CREATOR_NOT_FOUND — The creator was not found
• FORBIDDEN — You do not have permission to perform this action
• INTEGRATION_NOT_FOUND — The integration was not found

FlatfileSpaceNamespace

Values

• INTEGRATIONS
• PLATFORM

ImportJobStatus

The status of an ImportJob

Values

• CANCELLED
• COMPLETED
• FAILED
• PENDING
• STARTED

ImportJobType

The type of an ImportJob

Values

• INTEGRATIONS
• MESSAGING_SUBSCRIPTIONS