post https://www.rebuildingsociety.com/api/rs/BidPal
The BidPal endpoint enables 3rd party applications to configure the rebs BidPal settings.
Documentation
The BidPal endpoint enables 3th party applications to configure the rebs BidPal settings.
It is recomended that the authentication to this method is issued via access_token. Still you can [secretly] pass a user_key as a parameter and it will understand it just as good.
If you are using a framework that does not allow the Authorization to be in the header, you can still pass the access_token parameter as query string, the only requirement is that this has to be a POST request. Any other verb will result on loosing all the configurations.
Parameters
| Parameter | Definition |
|---|---|
| apikey | API access key supplied by Rebuilding Society |
| userkey | Token for User Authentication see Userkey |
| max_bid_limit | Limit in % of total user assets for single app bid |
| expiry_date | BidPal settings expiration date |
| risk_rate_a_plus | Rate for A+ risk apps |
| risk_rate_a | Rate for A risk apps |
| risk_rate_b | Rate for B risk apps |
| risk_rate_c | Rate for C risk apps |
| amount_a_plus | Maximum amount of bids for A+ risk apps |
| amount_a | Maximum amount of bids for A risk apps |
| amount_b | Maximum amount of bids for B risk apps |
| amount_c | Maximum amount of bids for C risk apps |
| active_a_plus | Enable settings for A+ risk apps |
| active_a | Enable settings for A risk apps |
| active_b | Enable settings for B risk apps |
| active_c | Enable settings for C risk apps |
| sector | Sectors, that should be excluded |
| location | Included business locations |