---
title: "Update role on a matter"
method: PUT
path: "/matters/{matterId}/roles/{id}"
tags: ["Roles"]
---

# Update role on a matter

`PUT /matters/{matterId}/roles/{id}`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/matters/{matterId}/roles/{id}`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Updates a specified role on a matter.

## Path parameters

- `matterId` string, uuid, required
- `id` string, uuid, required

## Request body

- RoleDto
  - `name` string, nullable: Name of the role.
  - `displayName` string, nullable: Display Name of the role.
  - `description` string, nullable: Description of the role.
  - `contactId` string, nullable: Unique identifier of the contact.
  - `representativeIds` string[], nullable: List of associated representative contact ids.
  - `isMatterItemRequired` boolean: Boolean flag indicating if matter item is required.
  - `relationships` RelationshipDto[], nullable: List if relationships associated with the role.
    - `name` string, nullable: Name of the relationship.
    - `displayName` string, nullable: Display Name of the relationship.
    - `contactId` string, nullable: Unique identifier of the contact.
    - `representativeIds` string[], nullable: List of associated representative contact ids.
    - `isMatterItemRequired` boolean: Boolean flag indicating if a matter item is required.

## Response `202`

When request is accepted. Returns a hypermedia 'Link' object of the role to be updated.

- Link
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable

## Other responses

- `404`: When the specified matter does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)