Endpoint portfolios.public subscribes / unsubscribes to a public portfolio
AMALYZE Falcon API
portfolios.public
Endpoint
Method
UPDT portfolios.public
Example call
Shell
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
curl https://falcon.amalyze.com/<VERSION>/portfolios.public \ -X UPDT \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "portfolios": [ { "id": "abcasdfaserasdfasdf", "marketplace": "A1PA6795UKMFR9", "action": "subscribe", "users": [] }, {...} ] } ' |
JSON Payload
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "portfolios": [ { "id": "abcasdfaserasdfasdf", "marketplace": "A1PA6795UKMFR9", "action": "subscribe", "users": [] }, {...} ] } |
| Property | Type | Description | Further information | Version |
portfolios | array | Array containing the portfolio objects | 0.5.0 | |
portfolios.marketplace | string | String containing the marketplace id | valid marketplaces ids | 0.4.0 |
portfolios.id | string | String containing the porfolios ID | 0.4.0 | |
portfolios.users | array | Array containing the users ID, the report shall be sent to | 0.4.0 | |
portfolios.action | string | String containing the action |
| 0.4.0 |
JSON Response
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "request": { "id": "eb84cbf0-9a57-4622-a470-a8aca915d0bd", "took": 0.5337, "costs": 0, "remaining": 100000, "method": "portfolios.public", "success": true, "error": { "code": null, "message": null, "hint": null }, "cache": { "generated": 1560237316, "cached": false, "id": null } } } |
| Property | Type | Description | Version |
request | object | The request information object (see Request information for more information) | 0.4.0 |
Updates / Changes
| Version | Description |
| 0.5.0 | updated to support update on multiple portfolios within one single request |
| 0.4.0 | created |