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

Sends a portal message

cURL

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 '
{
  "message": "<string>",
  "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
  "requireMFA": true
}
'

import requests

url = "https://api.smokeball.com/matters/{matterId}/portal/messages"

payload = {
    "message": "<string>",
    "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
    "requireMFA": True
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    message: '<string>',
    contactId: '93421c6f-40bd-465d-bb95-3b3b5e200e30',
    requireMFA: true
  })
};

fetch('https://api.smokeball.com/matters/{matterId}/portal/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/portal/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => '<string>',
    'contactId' => '93421c6f-40bd-465d-bb95-3b3b5e200e30',
    'requireMFA' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/portal/messages"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"contactId\": \"93421c6f-40bd-465d-bb95-3b3b5e200e30\",\n  \"requireMFA\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.smokeball.com/matters/{matterId}/portal/messages")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"message\": \"<string>\",\n  \"contactId\": \"93421c6f-40bd-465d-bb95-3b3b5e200e30\",\n  \"requireMFA\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/portal/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"message\": \"<string>\",\n  \"contactId\": \"93421c6f-40bd-465d-bb95-3b3b5e200e30\",\n  \"requireMFA\": true\n}"

response = http.request(request)
puts response.read_body

400

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string<uuid> · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

message · string · required

Minimum string 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

202

When request is accepted.