Update a mortgage search | PlannrCRM API documentation

Update a mortgage search Run in API Explorer

PUT /api/v2/mortgage-searches/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

application/json

Body

name string Required

The name of the mortgage search

Maximum length is 255.

Responses

200 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.
- name string
  
  The name of the mortgage search
- status string
  
  The status of the mortgage search
- provider string
  
  The provider that the mortgage search is for
- provider_reference string
  
  The provider reference of the mortgage search
- provider_data array
  
  Any provider data related to the mortgage search
- applicants array[object]
  
  The applicants of the mortgage search
  
  Hide applicants attributes Show applicants attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  account string
- cases array[object]
  
  The cases that are related to the mortgage search
  
  Hide cases attributes Show cases attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  status string
  
  type string
  
  review_at string
  
  assigned_to_uuids array[string]
  
  group_uuids array[string]
  
  completed_at string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  status_position integer
  
  participants_count integer
  
  participants string
  
  task_board_uuid string
  
  plans string
  
  custom_fields string
- products array[object]
  
  The products that are related to the mortgage search
  
  Hide products attributes Show products attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  provider_reference string
  
  provider_scenario_name string
  
  provider_scenario_data array
  
  lender_name string
  
  product_title string
  
  files string
- files array[object]
  
  The files that are related to the mortgage search
  
  Hide files attributes Show files attributes object
  
  uuid string
  
  created_at string
  
  original_created_at string
  
  updated_at string
  
  uploaded_at string
  
  status string
  
  filename string
  
  name string
  
  extension string
  
  type string
  
  size string
  
  path string
  
  last_modified string
  
  progress string
  
  download_url string
  
  folder_name string
  
  folder string
  
  documentable_type string
  
  documentable string
  
  navigator object
  
  Hide navigator attributes Show navigator attributes object
  
  model_type string
  
  model_uuid string
  
  firm string
  
  account string
  
  tags string

PUT /api/v2/mortgage-searches/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/mortgage-searches/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"My Mortgage Search"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "My Mortgage Search"
}

Response examples (200)

{
  "name": "My Mortgage Search",
  "uuid": "66165df4-0822-46b4-aa23-9ee294164b7d",
  "cases": [
    {
      "name": "finance",
      "slug": "finance",
      "type": "App\\Http\\Resources\\CasesTypeResource",
      "uuid": "36eff86c-fa42-46f2-9616-ad6e1586503e",
      "plans": "App\\Http\\Resources\\Plans\\PlanResource",
      "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"
        }
      },
      "status": "App\\Http\\Resources\\CasesStatusResource",
      "review_at": "2026-03-16T13:04:50+00:00",
      "created_at": "2026-03-16T13:04:50+00:00",
      "updated_at": "2026-03-16T13:04:50+00:00",
      "group_uuids": [
        "02c22636-ba53-4902-b09f-4598d289174d"
      ],
      "completed_at": "2026-03-16T13:04:50+00:00",
      "participants": "App\\Http\\Resources\\AccountResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "status_position": 4,
      "task_board_uuid": "cd5e28f5-1b19-4334-b49e-e567bef92387",
      "assigned_to_uuids": [
        "7737e472-aa3a-4e92-a89c-30705d48c97c"
      ],
      "participants_count": 4
    }
  ],
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "fb5710b8-429e-4a27-8d3f-3faed07f71d2",
      "folder": "App\\Http\\Resources\\FolderResource",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "navigator": {
        "model_type": "account",
        "model_uuid": "a19c8df8-f52c-4db1-953e-353f3552eb7d"
      },
      "created_at": "2026-03-16T13:04:50+00:00",
      "updated_at": "2026-03-16T13:04:50+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2026-03-16T13:04:50+00:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/dbbec4cc-df3a-4998-b8f7-ff3a2a6c2927/download",
      "last_modified": "2026-03-16T13:04:50+00:00",
      "documentable_type": "account",
      "original_created_at": "2026-03-16T13:04:50+00:00"
    }
  ],
  "status": "pending",
  "products": [
    {
      "uuid": "0419aa31-01b3-46dc-8157-1f15575d5fd2",
      "files": "App\\Http\\Resources\\FileResource",
      "created_at": "2026-03-16T13:04:50+00:00",
      "updated_at": "2026-03-16T13:04:50+00:00",
      "lender_name": "HSBC",
      "product_title": "5% Fixed Rate - 5 year",
      "provider_reference": "example-reference",
      "provider_scenario_data": [],
      "provider_scenario_name": "Single Applicant, Small Deposit"
    }
  ],
  "provider": "Mortgage Brain",
  "applicants": [
    {
      "uuid": "9163988d-afb0-4529-9d21-ad70c9487538",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "created_at": "2026-03-16T13:04:50+00:00",
      "updated_at": "2026-03-16T13:04:50+00:00"
    }
  ],
  "created_at": "2026-03-16T13:04:50+00:00",
  "updated_at": "2026-03-16T13:04:50+00:00",
  "provider_data": [],
  "provider_reference": "123456789"
}