Skip to main content
PUT
cURL

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id
string
erforderlich

OfferRecipient identifier

Body

The updated OfferRecipient resource

role
enum<string> | null
erforderlich

The role of the recipient

Verfügbare Optionen:
read,
sign,
null

Antwort

OfferRecipient resource updated

id
string
read-only
email
string
firstName
string
lastName
string
offer
string<uuid>
Beispiel:

"https://example.com/"

role
enum<string>
Verfügbare Optionen:
read,
sign
createdAt
string<date-time>
read-only
signingStatus
enum<string>
Standard:not_started
read-only
Verfügbare Optionen:
pending,
started,
signed,
not_started,
archived
Beispiel:

"not_started"

signingLog
string[]
read-only
signedDocument
string<uuid> | null
read-only
Beispiel:

"https://example.com/"

Link to the offer for the recipient

Beispiel:

"https://example.com/offers/1/recipient-1"

signingName
string
read-only
signingNameRole
string
read-only
signatureDone
boolean
read-only
submissionSlug
string | null
read-only
tenantId
string
read-only