Skip to main content
POST
Import one file now with a feed

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

name
string
required
Required string length: 1 - 255

Body

application/json
as_of
string<date> | null

With csv or s3_key: a date in the period the file's usage is for. Unset: the period before the run, as for a file that arrives. A feed with a date column refuses it

csv
string | null

Or the whole file as CSV text (a bigger one goes by email or S3)

Required string length: 1 - 8388608
filename
string | null

With csv: the name it shows under, ending in .csv

Required string length: 1 - 124
import_id
string | null

A file the feed received: one held while it was off, or one that failed

Required string length: 1 - 64
s3_key
string | null

Or, for an S3 feed, an object under its prefix, read with its connection

Required string length: 1 - 1024

Response

200 - application/json

Successful Response

completed_at
string<date-time> | null
required
created_at
string<date-time>
required

When the file was received

feed
string | null
required

The file feed the file matched; null for an upload

file_name
string | null
required

The file's name; null when a delivery carried several files

id
string
required
object
string | null
required

What an upload updates, e.g. account or people; null for a feed's file

rows
ImportRows · object | null
required

Null until the file is processed

source
enum<string>
required

How the file arrived

Available options:
upload,
email,
s3,
api
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
held