Skip to main content
POST
Start a batch import for relationships

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
filename
string

S3 filename of the CSV

original_filename
string

Original uploaded filename

csv_entity_field
string

CSV header name for entity identifier

entity_field
string

Gratona entity field key used for matching

csv_donor_field
string

CSV header name for donor identifier

donor_field
string

Gratona donor field key used for matching

csv_commitment_field
string

CSV header name for commitment amount

csv_date_field
string

CSV header name for date

csv_frequency_field
string

CSV header name for frequency (accepted values: monthly, bi_weekly, 2_months, 3_months, 6_months, yearly)

csv_payment_method_field
string

CSV header name for payment method (accepted values: credit_card, bank_transfer, cash, check, wire_transfer, paypal, external)

is_per_period_amount
boolean

Whether the commitment amount is the charge per billing period. Defaults to false, meaning monthly base amount.

program_id
integer

Program ID

update_sponsorship
boolean

Whether to update existing sponsorships

Response

Batch import started successfully

message
string
Example:

"Relationship import batch has been started."

batch_id
integer
Example:

123