Skip to main content
POST
/
admin
/
sponsorships
Add a new sponsorship
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/sponsorships \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "donors": 1,
  "id": 1,
  "sp_amount": "100",
  "client_id": "1",
  "entity_id": 1,
  "entities": 1,
  "method": "3",
  "frequency": "1",
  "next": "2023-11-25"
}
'
{
  "message": "Sponsorship relationship successfully created."
}

Authorizations

​
X-HYS-API-Key
string
header
required

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

Body

application/json

Data required to create a new sponsorship

​
donors
integer

Donor ID

Example:

1

​
id
integer

Donor ID

Example:

1

​
sp_amount
string

Sponsorship amount

Example:

"100"

​
client_id
string
Example:

"1"

​
entity_id
integer

Entity ID

Example:

1

​
entities
integer

Entity ID

Example:

1

​
method
string

Payment method

Example:

"3"

​
frequency
string

Frequency of payment

Example:

"1"

​
next
string
Example:

"2023-11-25"

Response

Sponsorship relationship successfully created

​
message
string
Example:

"Sponsorship relationship successfully created."