Create a conversation.
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body 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 \
-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":"a6210e96-47f2-445b-a708-19920586e572","participants":["af971b5b-0abd-43cc-8ac6-5632640b4748","0fcdf4fe-5e24-4347-8d30-f9b884c3bb71"]}'
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": "a6210e96-47f2-445b-a708-19920586e572",
"participants": [
"af971b5b-0abd-43cc-8ac6-5632640b4748",
"0fcdf4fe-5e24-4347-8d30-f9b884c3bb71"
]
}
Response examples (200)
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "953f6523-49c0-4126-867e-1b805da32fb7",
"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-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00",
"completed_at": "2025-01-20T22:37:17+00:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "320049af-51d2-428f-903b-a0b26955833a",
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "fda179ba-4d5a-4b1d-9429-5aeb63590709",
"colour": "#ef4582",
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00"
}
],
"uuid": "98f80510-616b-4307-90ab-f9c2e0f1e080",
"pinned": true,
"is_admin": false,
"created_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "cfd62d26-54d3-4c04-9e67-04e38e420046",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-20T22:37:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:17+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-01-20T22:37:17+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-20T22:37:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-20T22:37:17+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-20T22:37:17+00:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "a33d8e56-e48a-42d5-a9ba-fe608889a852",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-01-20T22:37:17+00:00",
"deleted_at": "2025-01-20T22:37:17+00:00",
"updated_at": "2025-01-20T22:37:17+00:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}