Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Portal

Creates a portal task

Creates a new client portal task associated with the specified matter.

post/matters/{matterId}/portal/tasks

Path parameters

matterIdstring uuid required

Request body

contactIdstring uuid nullable

Unique identifier of the contact.

emailstring nullable

Email address of the contact. If provided, this takes precedence over ContactId.

externalUserIdstring required

The optional external user identifier of the external system.

titlestring required

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

urlstring required

The URL that will be displayed within the task content.

requireMFAboolean

Whether MFA is required before showing the task content.

optionalboolean

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

Optional tasks appear in a separate section in the UI.

actionTextstring nullable

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".

completedTextstring nullable

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

completedUrlstring nullable

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 request

{
  "contactId": "93421c6f-40bd-465d-bb95-3b3b5e200e30",
  "email": "contact@example.com",
  "title": "Sign: Verification of Identity",
  "url": "http://www.yourwebsite.com",
  "actionText": "Complete",
  "completedText": "Signing Complete!",
  "completedUrl": "http://www.yourwebsite.com"
}

Response

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