POST
/
matters
/
{matterId}
/
portal
/
messages
Sends a portal message
curl --request POST \
  --url https://api.smokeball.com/matters/{matterId}/portal/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
  "message": "<string>",
  "requireMFA": true
}'
This response does not have an example.

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

matterId
string<uuid>
required

Body

message
string
required
Minimum length: 1
contactId
string<uuid>

Unique identifier of the contact.

Example:

"93421c6f-40bd-465d-bb95-3b3b5e200e30"

requireMFA
boolean

Whether MFA is required before showing the message content.

Example:

true

Response

When request is accepted.