Update a custom default folder

PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
Personal access token & O auth2
application/json

Body Required

  • description string

    A description of the default folder structure

  • model string

    What model this default folder structure is for. Can be either client or case

  • structure array[string] Required

    The default folders structure.

  • is_active boolean

    Whether this default folder structure is active or not. Only one default folder structure for the same model and parameter can be active at a time.

  • parameter string

    The parameter for the default folder structure. If the model is client, this can be either individual, trust, business or shared. If the type is case, this can be any of the case types that are available in the firm.

  • for_existing boolean

    Whether this default folder structure is applied to existing clients or not. If this is false, the default folder structure will only be applied to new clients.

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.

    • description string

      The description of the custom default folders structure.

    • model string

      The model the default folders structure is for.

    • parameter string

      The parameter the default folders structure is for.

    • case_type object

      The case type object when model is "case" and the parameter is a valid case type UUID.

    • structure array[object]

      The default folders structure.

    • is_active boolean

      Whether the default folders structure is active.

    • for_existing boolean

      Whether the default folders structure is for existing clients.
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/custom-default-folder/customDefaultFolder_uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"description":"Default folder structure for standard clients","model":"client","structure":[{"name":"Documents","children":[{"name":"Contracts","children":[]},{"name":"Emails","children":[]}]},{"name":"Notes","children":[]}],"is_active":"true","parameter":"individual","for_existing":"true"}'
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
{
  "description": "Default folder structure for standard clients",
  "model": "client",
  "structure": [
    {
      "name": "Documents",
      "children": [
        {
          "name": "Contracts",
          "children": []
        },
        {
          "name": "Emails",
          "children": []
        }
      ]
    },
    {
      "name": "Notes",
      "children": []
    }
  ],
  "is_active": "true",
  "parameter": "individual",
  "for_existing": "true"
}
Response examples (201) 
{
  "uuid": "834edda1-5528-43f7-9f41-70cac1a1e8e0",
  "model": "client",
  "case_type": {
    "name": "Mortgage Plan",
    "uuid": "79cd95d6-c728-4953-803b-104bb90b8eab",
    "created_at": "2025-04-03T15:34:23+01:00",
    "updated_at": "2025-04-03T15:34:23+01:00"
  },
  "is_active": true,
  "parameter": "client",
  "structure": [
    {
      "name": "Documents",
      "children": [
        {
          "name": "Contracts",
          "children": []
        },
        {
          "name": "Emails",
          "children": []
        }
      ]
    },
    {
      "name": "Notes",
      "children": []
    }
  ],
  "created_at": "2025-04-03T15:34:23+01:00",
  "updated_at": "2025-04-03T15:34:23+01:00",
  "description": "Shared client default folders",
  "for_existing": true
}