Update roles in the package

put

https://rls.congacloud.com/api/sign/v1/cs-packages/{packageId}/roles/{roleId}

Updates a single Role by overriding its existing values with those in the JSON payload.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

packageId

string

required

The unique package id.

roleId

string

required

The unique role id within the package.

Body Params

The updated role data.

attachmentRequirements

array of objects

Signer attachment requirements.

attachmentRequirements

data

object

Role metadata.

emailMessage

Role email message.

string

Role Id.

index

int32

Role signing order index.

locked

boolean

Is role locked. Role will be locked after failing to sign in multiple times.

name

string

Role name.

reassign

boolean

Is the role able to reassign.

signers

array of objects

Signers associated with the role.

signers

specialTypes

array of strings

Special signer features. Currently only NOTARY is supported.

specialTypes

type

enum

Role type. Currently there are two types, SIGNER and SENDER.

downloadEvidenceSummaryBySigner

boolean

Indicates whether the signer assigned to this role can download the evidence summary once signing is complete.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Not Authorized

404

500Unexpected Error