POST
/
matters
/
{matterId}
/
portal
/
tasks
Creates a new portal task
curl --request POST \
  --url https://api.smokeball.com/matters/{matterId}/portal/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
  "externalUserId": "<string>",
  "title": "Sign: Verification of Identity",
  "url": "<string>",
  "requireMFA": true,
  "optional": true,
  "actionText": "Complete",
  "completedText": "Signing Complete!",
  "completedUrl": "http://www.yourwebsite.com"
}'
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

​
contactId
string<uuid>
required

Unique identifier of the contact.

Example:

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

​
externalUserId
string
required

The optional external user identifier of the external system.

Minimum length: 1
​
title
string
required

The title of the task to be displayed in the UI.

Minimum length: 1
Example:

"Sign: Verification of Identity"

​
url
string
required
Minimum length: 1
​
requireMFA
boolean

Whether MFA is required before showing the task content.

​
optional
boolean

Whether the this task is "Required" or "Optional".

Optional tasks appear in a separate section in the UI.

​
actionText
string | null

Optional action text, a single word to describe the action the task relates to.

Defaults to "Complete", but other examples could be "Sign" or "Review".

Example:

"Complete"

​
completedText
string | null

Optional completed text, used on the task success screen if provided.

Example:

"Signing Complete!"

​
completedUrl
string | null

Optional completed URL, which is a URL that is loaded in the task content body instead of the default success screen if provided.

This option overrides CompletedText if provided.

Example:

"http://www.yourwebsite.com"

Response

When request is accepted. Returns the id of the task to be created.