SMsmokeball
Portal

Sends a portal message

Sends a message to the specified contact on the client portal.

When using the Client Credentials grant type, include the UserId header to impersonate the lawyer in the firm who is sending the message.

post/matters/{matterId}/portal/messages

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/portal/messages
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring uuid required

Request body

contactIdstring uuid

Unique identifier of the contact.

messagestring required
requireMFAboolean

Whether MFA is required before showing the message content.

Example request

{
  "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
  "requireMFA": true
}

Response

When request is accepted.

Changes

No recorded changes to this operation across all 15 revisions of this API.