Create a message

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

Personal access token & OAuth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

conversation_uuid integer Required

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
  
  Additional properties are allowed.
- author object
  
  Message author
  
  Additional properties are allowed.
- user object
  
  Message user
  
  Additional properties are allowed.
- reactions array[object]
  
  Array of reactions to the message
  
  Additional properties are allowed.

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": "2fc1487e-6880-43da-92ef-246d4824eb44",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-02-20T10:13:02+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:02+00:00",
    "otp_pending": false,
    "current_login": "App\\Http\\Resources\\LoginResource",
    "current_account": "App\\Http\\Resources\\AccountResource",
    "two_factor_type": "sms",
    "otp_confirmed_at": "2025-02-20T10:13:02+00:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2025-02-20T10:13:02+00: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": "275f7c8b-9510-4281-9a8b-66fb0888a456",
  "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": "40451780-aee5-4056-9b55-6fda1225cfea",
      "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": "17cca5e5-2910-408f-89c7-7b7aa792344b"
      },
      "created_at": "2025-02-20T10:13:02+00:00",
      "updated_at": "2025-02-20T10:13:02+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-02-20T10:13:02+00:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/23b6f8e1-d794-4a94-a96f-922b95618ff0/download",
      "last_modified": "2025-02-20T10:13:02+00:00",
      "documentable_type": "account",
      "original_created_at": "2025-02-20T10:13:02+00:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "b81ffb1e-7a35-4287-a153-56bfda42a3a6",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:02+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:02+00:00",
    "with_login": true,
    "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-02-20T10:13:02+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:02+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:02+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:02+00:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "06e7aa0f-464e-47c9-9599-d65ff4308788",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2025-02-20T10:13:02+00:00",
      "updated_at": "2025-02-20T10:13:02+00:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "2145d392-3a85-4309-b167-4521083256ff"
    }
  ],
  "created_at": "2025-02-20T10:13:02+00:00",
  "deleted_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00"
}