Product DocumentationConga Community
API Reference

Unlock a role

post
https://rls.congacloud.com/api/sign/v1/cs-packages//roles//unlock

Unlocks a specified role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique package id.

string
required

The unique role id within the package.

Body Params

The role to unlock.

attachmentRequirements
array of objects

Signer attachment requirements.

attachmentRequirements
data
object

Role metadata.

emailMessage

Role email message.

string

Role Id.

int32

Role signing order index.

boolean

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

string

Role name.

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
enum

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

boolean

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

Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago