PortfolioLinkApi

<back to all web services

UpdatePartnerSettings

Requires Authentication
The following routes are available for this service:
All Verbs/settings/update
UpdatePartnerSettings Parameters:
NameParameterData TypeRequiredDescription
PartnerIdqueryintNo
PartnerLogoUrlquerystringNo
PartnerBackgroundTypequerystringNo
PartnerBackgroundUrlquerystringNo
HellosignapikeyquerystringNo
ExpectedInflationRatequerydecimalNo
WithdrawalIncomeGrowthRatequerydecimalNo
UpdatePartnerSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformintNo
PartnerLogoUrlformstringNo
PartnerBackgroundTypeformstringNo
PartnerBackgroundUrlformstringNo
HellosignapikeyformstringNo
ExpectedInflationRateformdecimalNo
WithdrawalIncomeGrowthRateformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /settings/update HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"partnerId":0,"partnerLogoUrl":"String","partnerBackgroundType":"String","partnerBackgroundUrl":"String","hellosignapikey":"String","expectedInflationRate":0,"withdrawalIncomeGrowthRate":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"partnerId":0,"partnerLogoUrl":"String","partnerBackgroundType":"String","partnerBackgroundUrl":"String","hellosignapikey":"String","expectedInflationRate":0,"withdrawalIncomeGrowthRate":0}