Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
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
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":"ce1641fe-147c-4c5c-aeec-d2634696130a","participants":["dd107cfe-b024-485b-8452-8b57a68ba763","51734cc5-f74e-4163-be2e-d76619e948f7"]}'
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": "ce1641fe-147c-4c5c-aeec-d2634696130a",
"participants": [
"dd107cfe-b024-485b-8452-8b57a68ba763",
"51734cc5-f74e-4163-be2e-d76619e948f7"
]
}
Response examples (200)
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "56cfbf52-6219-4940-8fcb-c9d8e8c2bfa7",
"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-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"completed_at": "2025-04-22T13:44:18+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "35c105a7-0ba4-402a-b7c8-b74a780ad75b",
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "ea5fbc7b-9fcc-431d-92b3-50835455885d",
"colour": "#ef4582",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00"
}
],
"uuid": "7df40fca-d9d4-4225-9f33-1db78bfa4fd7",
"pinned": true,
"is_admin": false,
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "9d4298aa-a0a4-4f30-a213-d483eec5e857",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-22T13:44:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:18+01:00",
"with_login": true,
"inactive_at": "2025-04-22",
"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-04-22T13:44:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-22T13:44:18+01: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-04-22T13:44:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-22T13:44:18+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "de64288c-8d0e-4767-9dda-2f9d8e8539a2",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-04-22T13:44:18+01:00",
"deleted_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}