Import CSV for a specific program

POST

csv_import

{program_id}

curl --request POST \
  --url https://api.helpyousponsor.com/v1/csv_import/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "file": "<string>",
  "import_type": "<string>"
}
'

{
  "fields": [
    {}
  ],
  "first_row": [
    "<string>"
  ],
  "filename": "<string>",
  "program_id": 123,
  "program": {},
  "import_type": "<string>",
  "settings": {},
  "aii": true
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Path Parameters

program_id

integer

required

ID of the program

Body

application/json

CSV file and import type

file

string

CSV file to be imported

import_type

string

Type of import (recipients, donors, relationships, payments, emails)

Response

Successful operation

fields

object[]

Fields related to the import type

first_row

string[]

First row of the CSV file

filename

string

Name of the uploaded file

program_id

integer

ID of the program

program

object

Program details

import_type

string

Type of import

settings

object

Settings related to the import type

aii

boolean

Auto increment ID status

Import CSV for a specific program

curl --request POST \
  --url https://api.helpyousponsor.com/v1/csv_import/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "file": "<string>",
  "import_type": "<string>"
}
'

{
  "fields": [
    {}
  ],
  "first_row": [
    "<string>"
  ],
  "filename": "<string>",
  "program_id": 123,
  "program": {},
  "import_type": "<string>",
  "settings": {},
  "aii": true
}