Create a portfolio

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

Headers

Path parameters

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 \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/portfolios \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Risky Portfolio","is_proposed":false,"proposed_at":"2023-09-25"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
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": "5344eefd-5a70-4e6c-bb73-54a51cd363de",
  "created_at": "2024-10-16T11:10:16+01:00",
  "updated_at": "2024-10-16T11:10:16+01:00",
  "is_proposed": true,
  "proposed_at": "2024-10-16T00:00:00+01:00"
}