POST
/
portfolios
curl --request POST \
  --url https://api.copper.co/platform/portfolios \
  --header 'Content-Type: application/json' \
  --data '{
  "isDefiVault": true,
  "organizationId": "<string>",
  "parentPortfolioId": "<string>",
  "portfolioDescription": "My portfolio description",
  "portfolioId": "<string>",
  "portfolioName": "My portfolio",
  "portfolioType": "custody"
}'
{
  "createdAt": "1617235200000",
  "createdBy": "<string>",
  "extra": {
    "baseCurrency": "<string>",
    "clearLoopDelegationsBlocked": true,
    "clearLoopPortfolioId": "<string>",
    "clearLoopUnDelegationsBlocked": true,
    "clientAccountId": "<string>",
    "customerId": "<string>",
    "exchange": "okex",
    "externalAccountId": "<string>",
    "parentPortfolioId": "<string>",
    "quoteCurrency": "<string>",
    "showWalletBalance": "real",
    "usdWithdrawalLimit": "<string>"
  },
  "isActive": true,
  "organizationId": "1fa95ae7-5f74-4258-a4c6-687b39d7941d",
  "portfolioDescription": "My portfolio description",
  "portfolioId": "<string>",
  "portfolioName": "My portfolio",
  "portfolioType": "custody",
  "status": "active",
  "updatedAt": "1617235200000",
  "updatedBy": "<string>"
}

Body

application/json
​
portfolioId
string
required

Portfolio id

​
portfolioName
string
required

Portfolio name

Example:

"My portfolio"

​
portfolioType
enum<string>
required

Portfolio type. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
isDefiVault
boolean

Flag to indicate if the portfolio is a DeFi vault

​
organizationId
string

Organization id

​
parentPortfolioId
string

Parent portfolio id

​
portfolioDescription
string

Portfolio description

Example:

"My portfolio description"

Response

200
application/json
OK
​
createdAt
string
required

Portfolio creation date

Example:

"1617235200000"

​
createdBy
string
required

Portfolio creator ID

​
isActive
boolean
required

Portfolio active state

​
portfolioId
string
required

Portfolio id

​
portfolioName
string
required

Portfolio name

Example:

"My portfolio"

​
portfolioType
enum<string>
required

Portfolio type. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
extra
object

Portfolio extra data

​
organizationId
string

Organization ID

Example:

"1fa95ae7-5f74-4258-a4c6-687b39d7941d"

​
portfolioDescription
string

Portfolio description

Example:

"My portfolio description"

​
status
enum<string>

Portfolio status

​
updatedAt
string

Portfolio update date

Example:

"1617235200000"

​
updatedBy
string

Portfolio updater ID

Get PortfoliosRetrieve Portfolio by ID