Disqualify a lead Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
POST /api/v1/leads/{lead_uuid}/disqualify
Personal access token & O auth2

Marks the lead as dropped off, recording who, when and why. A caller with leads:updateAll disqualifies outright and may omit the reason. A caller with leads:update on an assigned lead must give a reason and only raises a pending request: the reason and requester are stored and disqualified_at stays null until a leads:updateAll holder calls this endpoint again to confirm, which keeps the stored reason unless a new one is sent. A no-op when the lead is already disqualified.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • lead_uuid string Required

    The UUID of the lead.

application/json

Body

  • reason string

    Why the lead dropped off. Required unless the caller has leads:updateAll.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • title string
    • first_name string
    • last_name string
    • name string
    • client_type string
    • date_of_birth string
    • status string
    • status_changed_at string
    • is_archived boolean
    • is_disqualified boolean
    • is_pending_disqualified boolean
    • is_promoted boolean
    • can_promote boolean
    • can_update boolean
    • can_archive boolean
    • can_disqualify string
    • can_assign boolean
    • can_update_introducer boolean
    • can_view_promoted boolean
    • source object
      Hide source attributes Show source attributes object
      • uuid string
      • name string
      • description string
      • position integer
      • archived boolean
      • sub_sources object
        Hide sub_sources attributes Show sub_sources attributes object
        • uuid

          The UUID of the resource.

        • name

          The name of the lead sub-source.

        • description

          An optional description of the lead sub-source.

        • position

          The position of the sub-source within its lead source's list.

        • archived

          Whether the sub-source is archived and hidden from selection.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • created_at string
      • updated_at string
    • sub_source object
      Hide sub_source attributes Show sub_source attributes object
      • uuid string
      • name string
      • description string
      • position integer
      • archived boolean
      • lead_source object
        Hide lead_source attributes Show lead_source attributes object
        • uuid

          The UUID of the resource.

        • name

          The name of the lead source.

        • description

          An optional description of the lead source.

        • position

          The position of the lead source within the firm's list.

        • archived

          Whether the lead source is archived and hidden from selection.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • created_at string
      • updated_at string
    • assigned_account object
      Hide assigned_account attributes Show assigned_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • introduced_by object
      Hide introduced_by attributes Show introduced_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • created_by object
      Hide created_by attributes Show created_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • archived_by object
      Hide archived_by attributes Show archived_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • disqualified_by object
      Hide disqualified_by attributes Show disqualified_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • promoted_by object
      Hide promoted_by attributes Show promoted_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • client_account object
      Hide client_account attributes Show client_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • primary_email object
      Hide primary_email attributes Show primary_email attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • value string
      • phone_number_meta object
        Hide phone_number_meta attributes Show phone_number_meta attributes object
        • country string
        • formatted string
      • accounts object
        Hide accounts attributes Show accounts attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

    • primary_phone_number object
      Hide primary_phone_number attributes Show primary_phone_number attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • value string
      • phone_number_meta object
        Hide phone_number_meta attributes Show phone_number_meta attributes object
        • country string
        • formatted string
      • accounts object
        Hide accounts attributes Show accounts attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

    • primary_address object
      Hide primary_address attributes Show primary_address attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • address_1 string
      • address_2 string
      • address_3 string
      • address_4 string
      • town_city string
      • county string
      • postcode string
      • country string
      • move_in_date string
      • accounts object
        Hide accounts attributes Show accounts attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

    • interests array[object]
      Hide interests attributes Show interests attributes object
      • uuid string
      • name string
      • description string
      • position integer
      • archived boolean
      • created_at string
      • updated_at string
    • custom_fields array[object]
      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
      • is_retired boolean
    • created_at string
    • updated_at string
  • 403 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
  • 404 application/json

    Lead belongs to another firm

    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
  • 409 application/json
    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
POST /api/v1/leads/{lead_uuid}/disqualify 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/leads/53f22fe4-3731-4cdc-aa12-e65bd0b15e52/disqualify' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "reason": "No longer interested"
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "reason": "No longer interested"
}
Response examples (200) 
{
  "uuid": "050a26ab-d4c4-467f-abdb-01d2bb386b06",
  "title": "mr",
  "first_name": "Sam",
  "last_name": "Patel",
  "name": "Sam Patel",
  "client_type": "individual",
  "date_of_birth": "1985-04-12",
  "status": "new",
  "status_changed_at": "2026-11-12T09:40:36+00:00",
  "is_archived": false,
  "is_disqualified": false,
  "is_pending_disqualified": false,
  "is_promoted": false,
  "can_promote": true,
  "can_update": true,
  "can_archive": true,
  "can_disqualify": "no",
  "can_assign": false,
  "can_update_introducer": false,
  "can_view_promoted": false,
  "source": {
    "uuid": "2ddf5b5b-190a-4b73-9969-87857a339f23",
    "name": "Website",
    "description": "Enquiries via the contact page",
    "position": 1,
    "archived": false,
    "sub_sources": {
      "uuid": "d70e2c3a-3385-465a-8564-c535376212eb",
      "name": "Google",
      "description": "Paid search on Google",
      "position": 1,
      "archived": false,
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00"
    },
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00"
  },
  "sub_source": {
    "uuid": "b01e8787-9ea7-42b9-9741-2564a242d35b",
    "name": "Google",
    "description": "Paid search on Google",
    "position": 1,
    "archived": false,
    "lead_source": {
      "uuid": "73a31090-e592-419b-8b22-edb28cf5825d",
      "name": "Website",
      "description": "Enquiries via the contact page",
      "position": 1,
      "archived": false,
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00"
    },
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00"
  },
  "assigned_account": {
    "uuid": "8f1abf63-22d8-4ad8-8c97-29eb5242747e",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "introduced_by": {
    "uuid": "fd299711-8c24-4901-bf6e-eda83d4b0fc4",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "created_by": {
    "uuid": "6a376591-1cc6-4fe9-9ebe-8eec8eda788c",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "archived_by": {
    "uuid": "1f70c4b3-d983-4094-a414-295b2ab4d948",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "disqualified_by": {
    "uuid": "cca25d73-aea3-4184-8cae-dd979d86552d",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "promoted_by": {
    "uuid": "cae490af-051a-4ec8-b301-5e91c5bc9ee1",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "client_account": {
    "uuid": "7c69fed2-bf74-49ed-805b-f56a3f21daee",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8060cb26-8d7f-490d-bfbf-d231292de88c",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "primary_email": {
    "uuid": "b0b8d54c-b779-43ad-9d99-c3fe0a8d03d3",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": {
      "uuid": "de33ecac-fcba-4adb-9a83-9c199aa01532",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-11-12T09:40:42+00:00",
      "next_review_date": "2026-11-12T09:40:42+00:00",
      "previous_review_date": "2026-11-12T09:40:42+00:00",
      "anniversary_review_date": "2026-11-12T09:40:42+00:00",
      "terms_of_business_at": "2026-11-12T09:40:42+00:00",
      "client_agreement_at": "2026-11-12T09:40:42+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-11-12",
      "last_interaction_at": "2026-11-12 09:40:42",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-12T09:40:42+00:00",
      "out_of_office_until": "2026-11-12T09:40:42+00:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "managed_by_head_office": false
    }
  },
  "primary_phone_number": {
    "uuid": "3becdcf7-d26c-4e84-b421-8e684af4a99a",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "type": "phone_number",
    "name": "Work number",
    "value": "+443330903630",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    },
    "accounts": {
      "uuid": "de33ecac-fcba-4adb-9a83-9c199aa01532",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-11-12T09:40:42+00:00",
      "next_review_date": "2026-11-12T09:40:42+00:00",
      "previous_review_date": "2026-11-12T09:40:42+00:00",
      "anniversary_review_date": "2026-11-12T09:40:42+00:00",
      "terms_of_business_at": "2026-11-12T09:40:42+00:00",
      "client_agreement_at": "2026-11-12T09:40:42+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-11-12",
      "last_interaction_at": "2026-11-12 09:40:42",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-12T09:40:42+00:00",
      "out_of_office_until": "2026-11-12T09:40:42+00:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "managed_by_head_office": false
    }
  },
  "primary_address": {
    "uuid": "513ddad5-8c7c-4432-bad6-d6cc75da8c99",
    "created_at": "2026-11-12T09:40:36+00:00",
    "updated_at": "2026-11-12T09:40:36+00:00",
    "name": "Work Address",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "address_3": "The Innovative Centre",
    "address_4": "Waterlooville",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "move_in_date": "2025-11-12",
    "accounts": {
      "uuid": "de33ecac-fcba-4adb-9a83-9c199aa01532",
      "created_at": "2026-11-12T09:40:42+00:00",
      "updated_at": "2026-11-12T09:40:42+00:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-11-12T09:40:42+00:00",
      "next_review_date": "2026-11-12T09:40:42+00:00",
      "previous_review_date": "2026-11-12T09:40:42+00:00",
      "anniversary_review_date": "2026-11-12T09:40:42+00:00",
      "terms_of_business_at": "2026-11-12T09:40:42+00:00",
      "client_agreement_at": "2026-11-12T09:40:42+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-11-12",
      "last_interaction_at": "2026-11-12 09:40:42",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-12T09:40:42+00:00",
      "out_of_office_until": "2026-11-12T09:40:42+00:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "managed_by_head_office": false
    }
  },
  "interests": [
    {
      "uuid": "d2550dd4-2e1d-4a75-8743-76424f5a6bc0",
      "name": "Wealth",
      "description": "Investment and wealth management enquiries",
      "position": 1,
      "archived": false,
      "created_at": "2026-11-12T09:40:36+00:00",
      "updated_at": "2026-11-12T09:40:36+00:00"
    }
  ],
  "custom_fields": [
    {
      "uuid": "04a85023-db79-4efb-8333-d487b5183071",
      "created_at": "2026-11-12T09:40:36+00:00",
      "updated_at": "2026-11-12T09:40:36+00:00",
      "type": "string",
      "name": "Favourite Drink",
      "reference": "favourite_drink",
      "is_required": false,
      "value": "Coffee",
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ],
      "help_text": "This is the client's favourite drink.",
      "is_retired": false
    }
  ],
  "created_at": "2026-11-12T09:40:36+00:00",
  "updated_at": "2026-11-12T09:40:36+00:00"
}
Response examples (403) 
{
  "message": "This action is unauthorized."
}
Response examples (404) 
{
  "message": "Not Found"
}
Response examples (409) 
{
  "message": "This lead has been promoted to a client and is locked."
}
{
  "message": "Un-archive the lead before disqualifying it."
}
Response examples (422) 
{
  "message": "The reason field is required.",
  "errors": {
    "reason": [
      "The reason field is required."
    ]
  }
}