Create a message with inline files

POST /api/v1/conversation/{conversation_uuid}/messages/inline

Personal access token & O auth2

Used to create a message and upload files at the same time.

Path parameters

conversation_uuid string Required

application/json

Body Required

contents string

Contents of the message.
files array<file> Required

An array of files. This request should be sent with a Content-Type of multipart/form-data.

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.
- deleted_at string
  
  The timestamp of when the resource was deleted.
- contents string
  
  The message contents
- edited boolean
  
  Whether the message has been edited or not
- files array[object]
  
  Message file attachments
  
  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
- author object
  
  Message author
  
  Hide author attributes Show author 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
  
  custom_fields string
  
  external_references string
- user object
  
  Message user
  
  Hide user attributes Show user attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  current_account string
  
  current_login string
  
  two_factor_enabled boolean
  
  two_factor_type string
  
  otp_confirmed_at string
  
  otp_pending boolean
  
  sms_two_factor_enabled boolean
  
  two_factor_mobile boolean
  
  two_factor_mobile_meta object
  
  Hide two_factor_mobile_meta attributes Show two_factor_mobile_meta attributes object
  
  country string
  
  formatted string
  
  current_time_entry string
  
  session_expires_at string
  
  should_auto_save_notes boolean
- reactions array[object]
  
  Array of reactions to the message
  
  Hide reactions attributes Show reactions attributes object
  
  uuid string
  
  account_uuid string
  
  account_name string
  
  reaction string
  
  reactions string
  
  created_at string
  
  updated_at string

POST /api/v1/conversation/{conversation_uuid}/messages/inline

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/conversation/6ff8f7f6-1eb3-3525-be4a-3932c805afed/messages/inline' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"contents":"Hello, welcome to Plannr.","files":["my-file.pdf"]}'

Request examples

{
  "contents": "Hello, welcome to Plannr.",
  "files": [
    "my-file.pdf"
  ]
}

Response examples (200)

{
  "user": {
    "name": "Gareth Thompson",
    "type": "standard",
    "uuid": "0924511b-f5d5-4c28-90fe-049165272fef",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-09-19T13:04:06+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-09-19T13:04:06+01:00",
    "otp_pending": false,
    "current_login": "App\\Http\\Resources\\LoginResource",
    "current_account": "App\\Http\\Resources\\AccountResource",
    "two_factor_type": "sms",
    "otp_confirmed_at": "2025-09-19T13:04:06+01:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2025-09-19T13:04:06+01:00",
    "two_factor_enabled": true,
    "should_auto_save_notes": true,
    "sms_two_factor_enabled": true,
    "two_factor_mobile_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "uuid": "331898ae-f88f-42e0-b39b-cf84e8526ce5",
  "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": "0f0ab070-93a1-4ee8-b3d5-f17ebd9aa653",
      "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": "306ef394-9418-49ac-a803-f65fb3d76a89"
      },
      "created_at": "2025-09-19T13:04:06+01:00",
      "updated_at": "2025-09-19T13:04:06+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-09-19T13:04:06+01:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/b6f80b51-ca70-461a-9e80-01f7a96b24ed/download",
      "last_modified": "2025-09-19T13:04:06+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-09-19T13:04:06+01:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7563d316-26bd-44f7-817f-5f291e8c2f8a",
    "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": "2025-09-19T13:04:06+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-09-19T13:04:06+01:00",
    "with_login": true,
    "inactive_at": "2025-09-19",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-09-19T13:04:06+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-09-19T13:04:06+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-09-19T13:04:06+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-09-19T13:04:06+01:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "3cc3ec5a-ff98-4e6b-846e-4cb526ac7f9f",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2025-09-19T13:04:06+01:00",
      "updated_at": "2025-09-19T13:04:06+01:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "07d1cc5c-4831-44d2-a948-6589e3f6daea"
    }
  ],
  "created_at": "2025-09-19T13:04:06+01:00",
  "deleted_at": "2025-09-19T13:04:06+01:00",
  "updated_at": "2025-09-19T13:04:06+01:00"
}