API Reference

Create Conversation on Claim

post
https://api.claimable.com/claims//conversations

Create and send a new conversation on a claim.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Claim ID

Body Params

The object payload used to create and send the message/conversation.

integer

The ID of the user from whom the message should be sent. User must have sufficient privileges to send messages. If left blank the sender will be chosen automatically as the "Assigned To" user or, failing that, an adminstrator.

to
array of strings
required

An array of strings listing each recipient. Each string can be (1) a plain email address, (2) a keyword to indentify a specific claim party (e.g. "claimant", "assigned_to") or (3) a selector to identify multiple claim parties (e.g. "contacts:third_party" or "suppliers:adjuster").

to*
string
required

Message/email subject line.

string
required

Message/email body content. Supports markdown for formatting (only bold, italic, underline, lists and links).

boolean
Defaults to false

Indicates if the conversation should be pinned or not.

string
enum
Defaults to closed

Whether the conversation should be open or closed. Closed conversations re-open automatically when a reply is added to the thread.

Allowed:
Response

Updated 3 months ago

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago