Create a portfolio

POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required
subAccount_uuid string Required

application/json

Body Required

name string Required

The name of the portfolio. Must be unique within the sub-account it is created on.
is_proposed boolean

Denotes if the portfolio is proposed
proposed_at date

The proposed date of the portfolio. When omitted from the request the proposed date will be the date of creation.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- is_proposed boolean
  
  Denotes if the portfolio is proposed
- proposed_at string
  
  The date the portfolio was proposed.
- name string
  
  The name of the portfolio.

POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed/portfolios' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Risky Portfolio","is_proposed":false,"proposed_at":"2023-09-25"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Risky Portfolio",
  "is_proposed": false,
  "proposed_at": "2023-09-25"
}

Response examples (201)

{
  "name": "Risky Portfolio",
  "uuid": "d4115083-020e-43c0-b061-2dd6a6f54cbf",
  "created_at": "2025-06-26T11:37:08+01:00",
  "updated_at": "2025-06-26T11:37:08+01:00",
  "is_proposed": true,
  "proposed_at": "2025-06-26T00:00:00+01:00"
}