Verdocs - Update a role. See createRole for additional details on the parameters available.

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Rename the role. Note that role names must be unique within a template, so this may fail if the new name is already in use.

type?string

Type of role.

Value in"signer" | "cc" | "approver"

full_name?string

Default full name for the role.

email?string

Default email address for the role.

phone?string

Default (SMS-capable) phone number for the role.

message?string

Optional message to include in email and SMS signing invitations.

sequence?integer

Optional 1-based sequence number for the role.

Default1

order?integer

Optional 1-based order number for the role.

Default1

delegator?boolean

If true, the role may delegate their signing responsibility to another party.

kba_method?string

Active PIN- or Identity-based KBA for the role.

Value in"pin" | "identity" | 0

curl -X PATCH "https://api.verdocs.com/v2/roles/{template_id}/{role_id}" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name_locked": true,
  "order": 0,
  "sequence": 0
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}