Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Portal

Patch a portal task

Updates a client portal task.

patch/matters/{matterId}/portal/tasks/{taskId}

Path parameters

matterIdstring uuid required
taskIdstring uuid required

Request body

externalUserIdstring nullable

The optional external user identifier of the external system.

titlestring nullable

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

urlstring nullable

The URL that will be displayed within the task content.

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

cancelledboolean nullable

Whether the task is Cancelled

cancelledTextstring nullable

Optional cancelled text, used on the task cancelled screen if provided.

cancelledUrlstring nullable

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

This option overrides CancelledText if provided.

completedboolean nullable

Whether the task is Completed

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.

expiredboolean nullable

Whether the task is Expired

expiredTextstring nullable

Optional expired text, used on the task expired screen if provided.

expiredUrlstring nullable

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

This option overrides ExpiredText if provided.

Example request

{
  "title": "Sign: Verification of Identity",
  "url": "http://www.yourwebsite.com",
  "actionText": "Complete",
  "cancelled": true,
  "cancelledText": "Signing Cancelled!",
  "cancelledUrl": "http://www.yourwebsite.com",
  "completed": true,
  "completedText": "Signing Complete!",
  "completedUrl": "http://www.yourwebsite.com",
  "expired": true,
  "expiredText": "Signing Expired!",
  "expiredUrl": "http://www.yourwebsite.com"
}

Response

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