Verdocs - Update a role

Path Parameters

template_id*string

The template ID.

Formatuuid

role_name*string

The role name to update.

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

Response Body

`application/json`

curl -X PATCH "https://api.verdocs.com/v2/roles/TEMPLATE_ID/ROLE_NAME" \    -H "Authorization: Bearer ACCESS_TOKEN" \    -H "content-type: application/json" \    -d '{"param": "value"}'

{
  "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"
}

Update a role

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`