Create a message

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

Headers

Path parameters

application/json

Body Required

  • contents string Required

    Contents of the message.

  • files array[string] Required

    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 \
 -X POST https://api.plannrcrm.com/api/v1/conversation/conversation_uuid/messages \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"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": "f36121ba-e205-4c1f-b40a-6c7a80ff249b",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2024-10-16T11:10:14+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:14+01:00",
    "otp_pending": false,
    "current_login": "App\\Http\\Resources\\LoginResource",
    "current_account": "App\\Http\\Resources\\AccountResource",
    "two_factor_type": "sms",
    "otp_confirmed_at": "2024-10-16T11:10:14+01:00",
    "two_factor_mobile": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "session_expires_at": "2024-10-16T11:10:14+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": "cb2b8e53-39d6-4497-831f-4f759e91582c",
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "4b74a617-4b07-4676-8fc1-3976c090e8ad",
      "parent": "Object",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\AccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "created_at": "2024-10-16T11:10:14+01:00",
      "updated_at": "2024-10-16T11:10:14+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2024-10-16T11:10:14+01:00",
      "download_url": "https://plannr.valet/file/b6955765-ae62-49cf-b622-3caecd8b80d6/download",
      "last_modified": "2024-10-16T11:10:14+01:00",
      "original_created_at": "2024-10-16T11:10:14+01:00"
    }
  ],
  "author": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "de5864f1-53f9-47b3-9e35-1a9ee0484478",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:14+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:14+01: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": "2024-10-16T11:10:14+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:14+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:14+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:14+01:00"
  },
  "edited": true,
  "contents": "Welcome to Plannr!",
  "reactions": [
    {
      "uuid": "276481b8-183a-4468-8c5f-caf4e4da2719",
      "reaction": "like",
      "reactions": "App\\Http\\Resources\\ReactionResource",
      "created_at": "2024-10-16T11:10:14+01:00",
      "updated_at": "2024-10-16T11:10:14+01:00",
      "account_name": "Gareth Thompson",
      "account_uuid": "c416885b-89d5-4e07-bddb-4f9b138ba075"
    }
  ],
  "created_at": "2024-10-16T11:10:14+01:00",
  "deleted_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00"
}