Create a custom default folder

POST /api/v1/custom-default-folder

Headers

application/json

Body Required

description string

A description of the default folder structure
model string Required

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 Required

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. Leaving it null will make the custom default folders apply to all clients/cases.
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. Required if the model is client

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.

POST /api/v1/custom-default-folder

curl \
 -X POST https://api.plannrcrm.com/api/v1/custom-default-folder \
 -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 '{"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": "9e26f1f9-e9b7-4a32-b87e-1518bf6082df",
  "model": "client",
  "case_type": {
    "name": "Mortgage Plan",
    "uuid": "d18818ce-853d-4281-8ba4-3e1622f8e1d4",
    "created_at": "2024-10-16T11:10:17+01:00",
    "updated_at": "2024-10-16T11:10:17+01:00"
  },
  "is_active": true,
  "parameter": "client",
  "structure": [
    {
      "name": "Documents",
      "children": [
        {
          "name": "Contracts",
          "children": []
        },
        {
          "name": "Emails",
          "children": []
        }
      ]
    },
    {
      "name": "Notes",
      "children": []
    }
  ],
  "created_at": "2024-10-16T11:10:17+01:00",
  "updated_at": "2024-10-16T11:10:17+01:00",
  "description": "Shared client default folders",
  "for_existing": true
}