Create a message

POST /api/v1/conversation/{conversation_uuid}/messages
Personal access token & O auth2

Headers

Path parameters

application/json

Body

  • contents string

    Contents of the message.

  • files array[string]

    File UUIDs which are uploading, or has been uploaded but not yet been assigned to a model.

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

    • author object

      Message author

    • user object

      Message user

    • reactions array[object]

      Array of reactions to the message
POST /api/v1/conversation/{conversation_uuid}/messages 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/conversation/conversation_uuid/messages' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"contents":"Hello, welcome to Plannr.","files":[null,null]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "contents": "Hello, welcome to Plannr.",
  "files": [
    null,
    null
  ]
}
Response examples (200) 
{
  "user": {
    "name": "Gareth Thompson",
    "type": "standard",
    "uuid": "e0c4ef19-f93b-4000-9269-fd7a5556e3c6",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-22T13:44:18+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2025-04-22T13:44:18+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": "f3598511-45fa-4bd9-a137-7e1c212380eb",
  "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": "416c4626-a28b-4002-81d8-cce6c5b55bba",
      "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": "91a9b811-0bde-448b-96f4-4587e11e1e32"
      },
      "created_at": "2025-04-22T13:44:18+01:00",
      "updated_at": "2025-04-22T13:44:18+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-04-22T13:44:18+01:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/1f992c13-15bf-4710-882c-ecde34ee698c/download",
      "last_modified": "2025-04-22T13:44:18+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-04-22T13:44:18+01:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "ed68e59a-5b7f-47a2-8485-9043d6bc41dc",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:18+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:18+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:18+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:18+01:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "285f152a-3d95-4673-ae4f-be978af7649c",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2025-04-22T13:44:18+01:00",
      "updated_at": "2025-04-22T13:44:18+01:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "9c09c6f9-3799-4016-96b0-5398dd4f15c7"
    }
  ],
  "created_at": "2025-04-22T13:44:18+01:00",
  "deleted_at": "2025-04-22T13:44:18+01:00",
  "updated_at": "2025-04-22T13:44:18+01:00"
}