Create a conversation. | PlannrCRM API documentation

Create a conversation. Run in API Explorer

POST /api/v1/conversation

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

name string Required

Conversation title
case string

Case UUID to assign this conversation to
participants array[string]

Account UUIDs belonging to the firm
message string

Contents of first message to be created alongside the conversation.

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.
- name string
  
  Conversation title
- slug string
  
  Conversation title as a slug
- belongs_to_case boolean
  
  Whether or not the conversation belongs to a case.
- case object
  
  Case the conversation belongs to (if included)
  
  Hide case attributes Show case attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  status string
  
  type string
  
  review_at string
  
  assigned_to_uuids array[string]
  
  group_uuids array[string]
  
  completed_at string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  status_position integer
  
  participants_count integer
  
  participants string
  
  task_board_uuid string
  
  plans string
  
  custom_fields string
- participants_count integer
  
  Number of participants in conversation (if included)
- participants array[object]
  
  Participants in this conversation (if included)
  
  Hide participants attributes Show participants 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
- latest_message object
  
  The latest message of the conversation (if included)
  
  Hide latest_message attributes Show latest_message attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  deleted_at string
  
  contents string
  
  edited boolean
  
  files string
  
  author string
  
  user string
  
  reactions string
- messages_count integer
  
  Number of messages in the conversation (if included)
- files_count integer
  
  Number of files in the conversation (if included)
- tags array[object]
  
  Conversation tags (if included)
  
  Hide tags attributes Show tags attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string
- pinned boolean
  
  Whether the conversation has been pinned to the top (if participants included)
- is_admin boolean
  
  If the authenticated account is an admin of the conversation (if participants included)

POST /api/v1/conversation

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/conversation' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Annual Review","case":"f7a7bb84-5232-4b7b-9cf3-82f45d24517d","participants":["fcdafa53-dac8-4fbf-b497-6a7614803c23","6582eab1-fda4-4b50-bc74-392531eb8ced"],"message":"Hello world!"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Annual Review",
  "case": "f7a7bb84-5232-4b7b-9cf3-82f45d24517d",
  "participants": [
    "fcdafa53-dac8-4fbf-b497-6a7614803c23",
    "6582eab1-fda4-4b50-bc74-392531eb8ced"
  ],
  "message": "Hello world!"
}

Response examples (200)

{
  "case": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "eb5a2ecd-78b8-43e8-958e-fb441a0651ff",
    "plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "status": "App\\Http\\Resources\\CasesStatusResource",
    "review_at": "2025-12-04T22:09:15+00:00",
    "created_at": "2025-12-04T22:09:15+00:00",
    "updated_at": "2025-12-04T22:09:15+00:00",
    "group_uuids": [
      "6f1ae89e-6ea3-400c-b4fa-f49021334ec3"
    ],
    "completed_at": "2025-12-04T22:09:15+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "fb175b5e-e750-49c5-ae85-69b877f5d3ba",
    "assigned_to_uuids": [
      "7998037c-0482-4a5d-aba1-b65d7c41cd45"
    ],
    "participants_count": 4
  },
  "name": "Welcome to Plannr",
  "slug": "welcome-to-plannr",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "9a964d0e-c833-4f13-8fd5-5b7f2121c184",
      "colour": "#ef4582",
      "created_at": "2025-12-04T22:09:15+00:00",
      "updated_at": "2025-12-04T22:09:15+00:00"
    }
  ],
  "uuid": "33f06ef7-2ecb-4895-ba4e-1940e7ae46fe",
  "pinned": true,
  "is_admin": false,
  "created_at": "2025-12-04T22:09:15+00:00",
  "updated_at": "2025-12-04T22:09:15+00:00",
  "files_count": 2,
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "606fc4ef-ab4d-4629-a880-fa447e725739",
      "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-12-04T22:09:15+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-12-04T22:09:15+00:00",
      "with_login": true,
      "inactive_at": "2025-12-04",
      "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-12-04T22:09:15+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-12-04T22:09:15+00: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-12-04T22:09:15+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-12-04T22:09:15+00:00"
    }
  ],
  "latest_message": {
    "user": "App\\Http\\Resources\\UserResource",
    "uuid": "604163ab-c177-45b2-9dcc-949d2bfc0e94",
    "files": "App\\Http\\Resources\\FileResource",
    "author": "App\\Http\\Resources\\AccountResource",
    "edited": true,
    "contents": "Welcome to Plannr!",
    "reactions": "App\\Http\\Resources\\ReactionResource",
    "created_at": "2025-12-04T22:09:15+00:00",
    "deleted_at": "2025-12-04T22:09:15+00:00",
    "updated_at": "2025-12-04T22:09:15+00:00"
  },
  "messages_count": 30,
  "belongs_to_case": true,
  "participants_count": 3
}