Send a message to the client on a deal

post

https://sandbox.capvant.com/v1/deals/{ref}/messages

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.

In: header

ref*string

The deal reference, e.g. CV93A41205. Case-insensitive.

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body?string

Required unless request_upload is true, in which case a default upload-request message is used.

Lengthlength <= 8000

request_upload?boolean

Attach a secure document-upload link to the notification.

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}