Update Portfolio

Update Trading Portfolio's name by a primary user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Renames an existing RapidX Portfolio under the main user. Its Portfolio ID is unchanged; this operation does not change its balances or positions.

API key access

Requires a signed LTP Open API request with TRADE permission.

API key typeCan callScope
Main User Level API key (also the main Portfolio key)YesRenames a Portfolio under the main user.
Sub-user Level API keyNoNot supported by this endpoint.
Dedicated Sub Portfolio API keyNoNot supported by this endpoint.

Rate limit: 3 requests per 10 seconds.

Request body

Send a JSON object with Content-Type: application/json.

FieldTypeRequiredDescription
portfolioIdLongYesPortfolio identifier.
nameStringYesNew portfolio name: 6–20 characters, letters and numbers only, cannot be all numeric, case-sensitive.

Response fields

FieldTypeDescription
codeintegerApplication result code. 200 means success.
messagestringResult message.
dataobjectPortfolio result.
data.portfolioIdinteger (int64)Portfolio identifier. Preserve the full integer value.
data.namestringPortfolio name after this operation.

Example Request

{
  "portfolioId": 2154503491108165,
  "name": "NewPortfolioName"
}

Example Response

{
  "code": 200,
  "message": "success",
  "data": {
    "portfolioId": 2154503491108165,
    "name": "NewPortfolioName"
  }
}

Check the application code, not only the HTTP status. See Error codes for error responses.

Body Params
int64
required

portfolio id

string
required

portfolio name

Response

Language
LoadingLoading…
Response
Choose an example:
application/json