Skip to main content
POST
Add a new commitment

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

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

Commitment relationship successfully created

message
string
Example:

"Commitment relationship successfully created."