Update Participant by ID

PATCH

sign

envelopes

{envelopeID}

participants

{participantID}

Update Participant by ID

curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants/{participantID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authentication": {
    "accessCode": "<string>"
  }
}
'

{
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "<string>",
  "authentication": {
    "accessCode": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

envelopeID

string<uuid>

required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

participantID

string<uuid>

required

A unique UUIDv4 string that identifies the participant in the Nitro system.

Body

application/json

authentication

Access Code · object

Participant authentication. Optional field.

Access Code
SMS

Show child attributes

Response

Participant updated successfully

string<uuid>

The unique identifier of the participant

string

The email address of the participant

role

string

The role of the participant

authentication

Access Code · object

Participant authentication

Access Code
SMS

Show child attributes

ChangelogProduct updates and announcements

Update Participant by ID

curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants/{participantID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authentication": {
    "accessCode": "<string>"
  }
}
'

{
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "<string>",
  "authentication": {
    "accessCode": "<string>"
  }
}