---
title: "Update Participant by ID"
method: PATCH
path: "/sign/envelopes/{envelopeID}/participants/{participantID}"
tags: ["Sign"]
---

# Update Participant by ID

`PATCH /sign/envelopes/{envelopeID}/participants/{participantID}`

## Request

- Base URL: `https://api.gonitro.dev`
- URL: `https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants/{participantID}`
- Auth: HTTP bearer

The **Update Participant by ID** endpoint modifies a participant's authentication settings.
The participant's email cannot be updated. All parameters are optional.

## Path parameters

- `envelopeID` string, uuid, required
- `participantID` string, uuid, required

## Request body

- ParticipantUpdate
  - `authentication` union: Participant authentication. Optional field.
    - AccessCode: Access code
      - `accessCode` string: Access code. It must contain between 4-32 characters.
      - `type` 'AccessCode'
    - SMS: SMS
      - `countryCode` string: Country code. It must start with `+` and be followed by 1-4 digits. For example +1, +55, +598
      - `phoneNumber` string: Phone number. Enter digits only, without a country code or formatting characters.
      - `type` 'SMS'

## Response `200`

Participant updated successfully

- Participant
  - `ID` string, uuid: The unique identifier of the participant
  - `email` string: The email address of the participant
  - `role` string: The role of the participant
  - `authentication` union: Participant authentication
    - AccessCode: Access code
      - `accessCode` string: Access code. It must contain between 4-32 characters.
      - `type` 'AccessCode'
    - SMS: SMS
      - `countryCode` string: Country code. It must start with `+` and be followed by 1-4 digits. For example +1, +55, +598
      - `phoneNumber` string: Phone number. Enter digits only, without a country code or formatting characters.
      - `type` 'SMS'

## Other responses

- `400`: Invalid request
- `401`: Unauthorized - Invalid or missing JWT token
- `404`: Envelope or participant not found

---

[API](https://skmtc.dev/gonitro/apis/nitro-sign-public-api.md) - [All operations](https://skmtc.dev/gonitro/apis/nitro-sign-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gonitro/apis/nitro-sign-public-api/revisions/fc0d2e7e0460?raw)