Our latest upgrade to the Claimable API introduces Conversations & Messages endpoints, allowing you to send emails directly via our API.

Sending a Message via API

Sending an email is as simple as a single POST request to /claims/:claim_id/conversations with a minimal JSON payload, for example:

{
  "to": ["claimant", "assigned_to", "john.smith@example.com"],
  "subject": "Claim #1234 - More Details Required",
  "body": "Dear Mr Jones, We have received your claim #1234..."
}

The above example will create a new outbound conversation/message on the claim which will be sent to (1) the claimant, (2) the user the claim is assigned to (e.g. claim handler) and (3) john.smith@example.com.

In addition to support for dynamic claim party keywords (such as claimant and assigned_to), the Claimable API will automatically match recipients' corresponding contact or company profile based on email, if present in your Claimable account. We also intelligently set the sender if left blank or you can specify it explicitly.

You can read more about dynamic recipient selection, smart profile matching and automatic sender selection in the ConversationCreate object definition..

These smart defaults mean there are just 3 required attributes needed to send an email using the Claimable API: to, subject and body . This simple approach makes it easier than ever to build automated communication into your claims workflows.

A newly API-created conversation will show on the Messages tab in Claimable, just like any user-generated conversation. Users can interact with it just like any other conversation and any replies will be handled in the normal way and routed to the claim in question.

To support this new functionality we've introduced four new objects to our API schema.

New Objects Added to API Schema

Object	Description
Conversation	`Conversation` objects represent message threads between two or more participants, relating to a `Claim`.
ConversationCreate	`ConversationCreate` objects are only used for creating conversations and support sending messages with as little as 3 attributes.
ConversationParticipant	`ConversationParticipant` objects describe a single participant in a `Conversation` who can send messages and receive replies.
Message	`Message` objects represent a reply to an existing `Conversation` or the message that originated a new `Conversation`.

New Endpoints for Fetching and Sending Emails / Messages

Fetch all conversations on a claim
Fetch a single conversation on a claim
Fetch all messages as part of a conversation
Fetch a single message as part of a conversation
Start a new conversation and send a message relating to a claim

📘
Get an Claimable API Token: If you haven't already, request an API token so you can start sending claim emails with the Claimable API.

💡 Guides

Getting Started

Using the API

Webhooks

No Code Integrations

📘 API Reference

Getting Started

API Objects

Claimable API