Create a conversation.

POST /api/v1/conversation

Personal access token & OAuth2

Headers

application/json

Body Required

name string Required

Conversation title
case string

Case uuid to assign this conversation too
participants array[string]

Account uuids belonging to the firm

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)
  
  Additional properties are allowed.
- participants_count integer
  
  Number of participants in conversation (if included)
- participants array[object]
  
  Participants in this conversation (if included)
  
  Additional properties are allowed.
- latest_message object
  
  The latest message of the conversation (if included)
  
  Additional properties are allowed.
- 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)
  
  Additional properties are allowed.
- 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 {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Annual Review","case":"8feb150d-2cf3-4f61-a279-d1803e0aa55f","participants":["d5c34d71-50c4-4942-bbe6-fed52dcc70a2","5208a9c6-9e04-4e8f-b154-41009768a892"]}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Annual Review",
  "case": "8feb150d-2cf3-4f61-a279-d1803e0aa55f",
  "participants": [
    "d5c34d71-50c4-4942-bbe6-fed52dcc70a2",
    "5208a9c6-9e04-4e8f-b154-41009768a892"
  ]
}

Response examples (200)

{
  "case": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "7763c2d7-ba9e-488c-ab57-c2d9992d16f5",
    "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",
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00",
    "completed_at": "2025-02-20T10:13:02+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "f58fbb58-9812-4f22-8ea4-f0fdfdf3a30c",
    "participants_count": 4
  },
  "name": "Welcome to Plannr",
  "slug": "welcome-to-plannr",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "239a30e3-4e28-4f91-bee1-4185059d231f",
      "colour": "#ef4582",
      "created_at": "2025-02-20T10:13:02+00:00",
      "updated_at": "2025-02-20T10:13:02+00:00"
    }
  ],
  "uuid": "97491498-ae52-4b99-9097-adcfd10d99f8",
  "pinned": true,
  "is_admin": false,
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00",
  "files_count": 2,
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "1ef7c8f8-87c0-4fe9-952e-b345eea9f4c7",
      "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"
    }
  ],
  "latest_message": {
    "user": "App\\Http\\Resources\\UserResource",
    "uuid": "bad10183-dadf-4564-97c1-02a47cece419",
    "files": "App\\Http\\Resources\\FileResource",
    "author": "App\\Http\\Resources\\AccountResource",
    "edited": true,
    "contents": "Welcome to Plannr!",
    "reactions": "App\\Http\\Resources\\ReactionResource",
    "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"
  },
  "messages_count": 30,
  "belongs_to_case": true,
  "participants_count": 3
}