Offer Recipient
Change the role of an offer recipient
PUT
/
offer-recipients
/
{id}
/
role
Authorizations
Authorization
string
headerrequiredValue for the Authorization header parameter.
Path Parameters
id
string
requiredOfferRecipient identifier
Body
role
enum<string> | null
requiredThe role of the recipient
Available options:
read
, sign
Response
200 - application/json
id
string
email
string
firstName
string
lastName
string
offer
string
role
enum<string>
Available options:
read
, sign
createdAt
string
signingStatus
enum<string>
default: not_startedAvailable options:
pending
, started
, signed
, not_started
, archived
signingLog
string[]
signedDocument
string | null
link
string
Link to the offer for the recipient
signingName
string
signingNameRole
string
signatureDone
boolean
submissionSlug
string | null
tenantId
string
Was this page helpful?