Skip to main content
POST
Create a file import 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.

Body

application/json
match
FeedMatch · object
required
name
string
required

Letters, digits and underscores; unique (also by case), and fixed once saved

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9_]+$
period
PeriodSettings · object
required
source
SourceSettings · object
required
allow_multiple_rows
boolean
default:false

Usage: keep every row for one account and date

clear_token
string | null

A cell holding only this text empties the field

Maximum string length: 1000
columns
ColumnSetting · object[]

One entry per target

Maximum array length: 2000
create_missing_people
boolean
default:false

Person rows: create a person whose email isn't found

custom_object_append_only
boolean
default:false

Objects: always add records, never update one

header_layout
HeaderLayout · object | null

Where the column names are; unset: row 1

row
enum<string>
default:account

What one row of the file is

Available options:
account,
person
validation_rules
RulesSettings · object | null

Response

200 - application/json

Successful Response

active
boolean
required

False: an email that arrives is held for the feed (status held), not imported; an S3 feed isn't polled

allow_multiple_rows
boolean
required

Usage: keep every row, even several for one account and date

clear_token
string | null
required

A cell holding only this text empties the field; null: off

columns
ImportColumn · object[]
required

Every mapped column, one entry per target

create_missing_people
boolean
required

Person rows: create a person whose email isn't found

created_at
string<date-time>
required
custom_object_append_only
boolean
required

Objects: always add records, never update one

header_layout
HeaderRows · object | null
required

Where the column names are; null: row 1

match
FeedMatch · object
required
name
string
required

Unique; an email feed's address carries it

period
FeedPeriod · object
required
row
enum<string>
required

What one row of the file is

Available options:
account,
person
source
FeedSource · object
required
updated_at
string<date-time>
required
validation_rules
ValidationRules · object
required

Validation rules for CSV processing.

version
string<date-time>
required

Send it as expected_version with a change or a delete