Create the import | PlannrCRM API documentation

Create the import Run in API Explorer

POST /api/v1/import

Fist step of the import process, must be mapped before it can be started Must be of Content-Type multipart/form-data

application/json

Body

type

string Required

Type of record to import.

Value	Description
business_staff_members	Business Staff Members
charges	Charges
circles	Circles
clients	Clients
group_scheme_members	Group Scheme Members
incomes	Incomes
notes	Notes
plans	Plans
premiums	Premiums
tasks	Tasks
valuations	Valuations
seccl_valuations	Seccl Valuations
expenses	Expenses
provider_statement	Provider Statement

Values are business_staff_members, charges, circles, clients, group_scheme_members, incomes, notes, plans, premiums, tasks, valuations, seccl_valuations, expenses, or provider_statement.

mode string Required

Type of import mode to enforce.

Value Description

store Store

update Update

validate Validate

Values are store, update, or validate.
file string(binary) Required

CSV file with import records

Value	Description
store	Store
update	Update
validate	Validate

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.
- type string
  
  The type of model the importer is importing
- mode string
  
  The mode this import was run on
- headers array[string]
  
  Headers taken from uploaded csv, not visible on index route
- mapping object
  
  Mapped headers, not visible on index route
  
  Hide mapping attributes Show mapping attributes object
  
  fname string
  
  lname string
  
  email string
- importable_uuid string
  
  The uuid of the model this importer is importing. For example, for a provider statement import, this would be the uuid of the provider statement being imported
- parameters object
  
  additional parameters for the import
  
  Hide parameters attribute Show parameters attribute object
  
  revenue_type_mapping object
  
  Hide revenue_type_mapping attributes Show revenue_type_mapping attributes object
  
  IF string
  
  ADJ string
- status string
  
  The status of the importer
- total_jobs integer
  
  Total amount of imports in the importer
- progress integer
  
  The current progress of the importer
- jobs_remaining integer
  
  Number of pending imports
- failed_jobs integer
  
  Number of failed imports
- error_report object
  
  Error report file
  
  Hide error_report attributes Show error_report 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
- errors object
  
  Array of failed imports, limited to 25 rows
  
  Hide errors attributes Show errors attributes object
  
  client object
  
  Hide client attributes Show client attributes object
  
  example array
  
  description string
  
  errors object
  
  Hide errors attributes Show errors attributes object
  
  example object
  
  Hide example attribute Show example attribute object
  
  send_welcome_email array[string]
  
  description string
- account object
  
  Account that initiated the import
  
  Hide account attributes Show 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
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string

POST /api/v1/import

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/import' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"business_staff_members","mode":"store","file":"file-contents"}'

Request examples

{
  "type": "business_staff_members",
  "mode": "store",
  "file": "file-contents"
}

Response examples (200)

{
  "mode": "store",
  "type": "clients",
  "uuid": "efa3f0f1-c30e-4069-8063-3a36bdf71cc8",
  "errors": {
    "client": {
      "example": [],
      "description": "Client that failed importing"
    },
    "errors": {
      "example": {
        "send_welcome_email": [
          "The send welcome email field is required."
        ]
      },
      "description": "The reasons why the client failed importing"
    }
  },
  "status": "processing",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "ea907d02-65b9-4a81-a98f-23e62bc60042",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-04-08T15:40:46+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-08T15:40:46+01:00",
    "with_login": true,
    "inactive_at": "2026-04-08",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-04-08T15:40:46+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-04-08T15:40:46+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-04-08 15:40:46",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-04-08T15:40:46+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-04-08T15:40:46+01:00"
  },
  "headers": [
    "fname",
    "lname",
    "email"
  ],
  "mapping": {
    "email": "email",
    "fname": "first_name",
    "lname": "last_name"
  },
  "progress": 100,
  "created_at": "2026-04-08T15:40:46+01:00",
  "parameters": {
    "revenue_type_mapping": {
      "IF": "initial_fee",
      "ADJ": "adjustment"
    }
  },
  "total_jobs": 4,
  "updated_at": "2026-04-08T15:40:46+01:00",
  "failed_jobs": 1,
  "error_report": {
    "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": "fcd83e73-455e-48fd-963d-748d9b20d55b",
    "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": "4d07e7ae-e756-4ca3-a3ea-95581a149668"
    },
    "created_at": "2026-04-08T15:40:46+01:00",
    "updated_at": "2026-04-08T15:40:46+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2026-04-08T15:40:46+01:00",
    "documentable": "Object",
    "download_url": "https://api.plannrcrm.com/file/406853c7-6757-4b59-a361-92e418362257/download",
    "last_modified": "2026-04-08T15:40:46+01:00",
    "documentable_type": "account",
    "original_created_at": "2026-04-08T15:40:46+01:00"
  },
  "jobs_remaining": 1,
  "importable_uuid": "05c343b8-a62d-429b-b97c-85611f58af78"
}