---
title: "Patch a portal task"
method: PATCH
path: "/matters/{matterId}/portal/tasks/{taskId}"
tags: ["Portal"]
---

# Patch a portal task

`PATCH /matters/{matterId}/portal/tasks/{taskId}`

Updates a client portal task.

## Path parameters

- `matterId` string, uuid, required
- `taskId` string, uuid, required

## Request body

- PatchPortalTaskDto
  - `externalUserId` string, nullable — The optional external user identifier of the external system.
  - `title` string, nullable — The title of the task to be displayed in the UI.
  - `url` string, nullable — The URL that will be displayed within the task content.
  - `actionText` string, 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".
  - `cancelled` boolean, nullable — Whether the task is Cancelled
  - `cancelledText` string, nullable — Optional cancelled text, used on the task cancelled screen if provided.
  - `cancelledUrl` string, 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.
  - `completed` boolean, nullable — Whether the task is Completed
  - `completedText` string, nullable — Optional completed text, used on the task success screen if provided.
  - `completedUrl` string, 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.
  - `expired` boolean, nullable — Whether the task is Expired
  - `expiredText` string, nullable — Optional expired text, used on the task expired screen if provided.
  - `expiredUrl` string, 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.

## Response `202`

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

## Other responses

- `400` — When an unsupported request is made.
- `403` — When the authenticated account does not have access to the matter.
- `404` — When matter with specified id does not exist.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/ffc7fffa0d5c/schema)