Process the import job for payments

POST

csv_process

{program_id}

payments

curl --request POST \
  --url https://api.helpyousponsor.com/v1/csv_process/{program_id}/payments \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "client_id": 1,
  "user_id": 1,
  "program_id": 1
}
'

{
  "message": "Your import has been queued. You will receive an email when the job has finished."
}

Authorizations

X-HYS-API-Key

string

header

required

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

Path Parameters

program_id

integer

required

Body

application/json

client_id

integer

Client ID

Example:

1

user_id

integer

User ID

Example:

1

program_id

integer

Program ID

Example:

1

Response

Successful operation

message

string

Example:

"Your import has been queued. You will receive an email when the job has finished."

Process the import job for sponsorship relationships

Process the import job for payments

curl --request POST \
  --url https://api.helpyousponsor.com/v1/csv_process/{program_id}/payments \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "client_id": 1,
  "user_id": 1,
  "program_id": 1
}
'

{
  "message": "Your import has been queued. You will receive an email when the job has finished."
}