---
title: "Rename a signer or change their signing order (draft only)"
method: PATCH
path: "/api/v1/documents/{id}/signers/{signerId}"
tags: ["Documents"]
---

# Rename a signer or change their signing order (draft only)

`PATCH /api/v1/documents/{id}/signers/{signerId}`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/documents/{id}/signers/{signerId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

## Path parameters

- `id` string, required
- `signerId` string, required

## Request body

- UpdateSignerDto
  - `name` string
  - `signingOrder` number: Signers with the same order sign at the same time; a higher order waits for every lower one.

## Response `200`

- SignerDto
  - `id` string, required
  - `documentId` string, required
  - `email` string, nullable
  - `name` string, required
  - `externalId` string, nullable
  - `role` 'signer' | 'approver' | 'cc', required
  - `signingOrder` number, required
  - `status` 'pending' | 'viewed' | 'signed' | 'declined', required
  - `authMethod` 'email_link' | 'access_link' | 'wallet_signature', required
  - `signedAt` string, date-time, nullable
  - `accessToken` string, required
  - `redirectUrl` string, nullable: URL to redirect signer after signing
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: Malformed UUID in path parameter (`id`, `signerId`).
- `404`: No such signer on this document

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)