Update a document pack

PUT /api/v1/document-pack/document-pack/{id}

Path parameters

  • id string Required

    The ID of the document pack.

application/json

Body Required

  • name string Required

    Name of the document pack.

  • description string Required

    Short description of the document pack.

  • is_template boolean

    Denotes whether document pack is a template or not.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
PUT /api/v1/document-pack/document-pack/{id} 
curl \
 -X PUT https://api.plannrcrm.com/api/v1/document-pack/document-pack/id \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"name":"Terms and Conditions","description":"Terms and Conditions for our services","is_template":true}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Terms and Conditions",
  "description": "Terms and Conditions for our services",
  "is_template": true
}
Response examples (200) 
{
  "data": [
    {
      "name": "John's ISA",
      "uuid": "2433c150-bf76-43c6-b9f5-2a8c37002f97",
      "created_at": "2024-11-20T13:24:02+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "updated_at": "2024-11-20T13:24:02+00:00",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "active_portfolio": {
        "name": "Risky Portfolio",
        "uuid": "4b681834-c230-45d4-9318-cdabc5ae7563",
        "created_at": "2024-11-20T13:24:02+00:00",
        "updated_at": "2024-11-20T13:24:02+00:00",
        "is_proposed": true,
        "proposed_at": "2024-11-20T00:00:00+00:00"
      },
      "latest_valuation": {
        "uuid": "f52f7c4d-8240-4631-8221-98f41a81e728",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "valued_at": "2024-11-20T13:24:02+00:00",
        "created_at": "2024-11-20T13:24:02+00:00",
        "updated_at": "2024-11-20T13:24:02+00:00",
        "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
      }
    }
  ]
}