Update a custom field

PUT /api/v1/custom-field/{customField_uuid}

Personal access token & O auth2

Path parameters

customField_uuid string Required
customField string Required

Optional parameter. UUID The UUID of the custom field

application/json

Body

type string

The custom field type. Available options: string, number, selection, boolean, datetime and longtext
name string

The name of the custom field. Must be unique for the model_type.
is_required boolean

Denotes if the custom field is required. If required, it must be specified when creating/updating a model.
is_visible_to_clients boolean

Denotes if the custom field is visible and editable to clients and their fact-finds.
model_type string

The type of model the custom field applies for. Available options: client, board_task, case, plan, task
help_text string

Optional help text to aide the custom field. Will be displayed on Plannr.
selection_options array[string]

If the type is "selection" this array must be provided. This is the array of available options for the selection box.
position integer

The position of the custom field. Will be placed last if left blank.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the custom field
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  The type of custom field
- name string
  
  The name of the custom field
- reference string
  
  The reference of the custom field, used when updating the custom field on the model.
- is_required boolean
  
  Denotes if the custom field is required
- model_type string
  
  The type of model that the custom field is for.
- help_text string
  
  Optional help text to aide the custom field. Will be displayed on Plannr.
- firm object
  
  The custom field firm
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
- selection_options array[string]
  
  This is the array of available options for the selection box. If the type is "selection" this array will be provided.
- is_visible_to_clients boolean
  
  Denotes if the custom field is visible and editable to clients.
- position integer
  
  The position of the custom field

PUT /api/v1/custom-field/{customField_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/custom-field/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"string","name":"Favourite Drink","is_required":true,"is_visible_to_clients":true,"model_type":"clients","help_text":"This is the client's favourite drink. You should make it for them before they arrive for meetings.","selection_options":["Tea","Coffee","Water"],"position":5}'

Request examples

{
  "type": "string",
  "name": "Favourite Drink",
  "is_required": true,
  "is_visible_to_clients": true,
  "model_type": "clients",
  "help_text": "This is the client's favourite drink. You should make it for them before they arrive for meetings.",
  "selection_options": [
    "Tea",
    "Coffee",
    "Water"
  ],
  "position": 5
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "0dbae417-eb40-4f47-baad-a7ca8170167e",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2025-06-26T11:37:10+01:00",
    "updated_at": "2025-06-26T11:37:10+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "portal_background": "#f6f6f6",
      "portal_brand_title": "#323b4b",
      "sidebar_background": "#0E0E56",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_text": "#323b4b",
      "portal_account_email": "#828994",
      "portal_sidebar_title": "#11151d",
      "sidebar_title_primary": "#FFC634",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_divider": "#e3e5e9",
      "email_button_background": "#36367E",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_text_hover": "#323b4b",
      "portal_sidebar_icon_active": "#828994",
      "portal_sidebar_text_active": "#323b4b",
      "email_logo_background_panel": "#36367E",
      "portal_sidebar_button_hover": "#ffffff",
      "portal_sidebar_account_title": "#11151d",
      "portal_sidebar_button_active": "#ffffff",
      "sidebar_title_secondary_hover": "#ffffff",
      "portal_sidebar_button_background": "#f6f6f6"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "name": "Favourite Drink",
  "type": "string",
  "uuid": "1b491e6b-4651-4b4f-b834-2616f83279e6",
  "position": 5,
  "help_text": "This is the client's favourite drink.",
  "reference": "favourite_drink",
  "created_at": "2025-06-26T11:37:10+01:00",
  "model_type": "client",
  "updated_at": "2025-06-26T11:37:10+01:00",
  "is_required": false,
  "selection_options": [
    "Coffee",
    "Tea",
    "Water"
  ],
  "is_visible_to_clients": true
}