Create a conversation.

POST /api/v1/conversation

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)
- participants_count integer
  
  Number of participants in conversation (if included)
- participants array[object]
  
  Participants in this conversation (if included)
- latest_message object
  
  The latest message of the conversation (if included)
- 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)
- 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 \
 -X POST https://api.plannrcrm.com/api/v1/conversation \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Annual Review","case":"028d04a9-4907-4922-9e51-54c0784bdb16","participants":["b4aba4f6-8b00-4ecf-a963-8498596ad7d8","74b7095d-c439-4947-928e-3d09f4831666"]}'

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": "028d04a9-4907-4922-9e51-54c0784bdb16",
  "participants": [
    "b4aba4f6-8b00-4ecf-a963-8498596ad7d8",
    "74b7095d-c439-4947-928e-3d09f4831666"
  ]
}

Response examples (200)

{
  "case": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "6c4bb34b-f84b-4644-864f-665c1be70dd3",
    "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": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01:00",
    "completed_at": "2024-10-16T11:10:14+01:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "68600958-646f-4332-a307-47aaca60d7fa",
    "participants_count": 4
  },
  "name": "Welcome to Plannr",
  "slug": "welcome-to-plannr",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "402cebf8-d5a3-452d-b856-effcd81f0f6f",
      "colour": "#ef4582",
      "created_at": "2024-10-16T11:10:14+01:00",
      "updated_at": "2024-10-16T11:10:14+01:00"
    }
  ],
  "uuid": "ad22e1a3-186b-4060-9ce4-e10dd9704d4b",
  "pinned": true,
  "is_admin": false,
  "created_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "files_count": 2,
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "a40ed1b4-3e16-43f6-91c1-738772f55a8b",
      "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"
    }
  ],
  "latest_message": {
    "user": "App\\Http\\Resources\\UserResource",
    "uuid": "5e9fd364-c9c4-494b-b7fc-f54f0c284512",
    "files": "App\\Http\\Resources\\FileResource",
    "author": "App\\Http\\Resources\\AccountResource",
    "edited": true,
    "contents": "Welcome to Plannr!",
    "reactions": "App\\Http\\Resources\\ReactionResource",
    "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"
  },
  "messages_count": 30,
  "belongs_to_case": true,
  "participants_count": 3
}