Send a message to the client on a deal
The client is notified by email; replies land back on the same thread.
Authorization
ApiKeyAuth X-API-Key<token>
Lender keys start with cv_live_; Partner keys start with cv_pk_. Shown once at creation, sent on every request. The Lender API has no separate sandbox key: the same cv_live_ key works on sandbox.capvant.com, where only your test deals exist.
In: header
Path Parameters
ref*string
The deal reference as it appears on the deal, for example 93A41205CE. Case-insensitive. Treat it as an opaque string: do not validate a prefix or a pattern.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Shell
curl -X POST "https://sandbox.capvant.com/deals/string/messages" \ -H "Content-Type: application/json" \ -d '{}'JSON
{ "id": "string", "notified": true, "status_intercepted": true}