Zum Hauptinhalt springen
PUT
/
offer-recipients
/
{id}
/
role
cURL
curl -X PUT \
 /offer-recipients/{id}/role \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "role": ""
}'
{
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "offer": "https://example.com/",
  "role": "read",
  "createdAt": "2023-11-07T05:31:56Z",
  "signingStatus": "not_started",
  "signingLog": [
    "<string>"
  ],
  "signedDocument": "https://example.com/",
  "link": "https://example.com/offers/1/recipient-1",
  "signingName": "<string>",
  "signingNameRole": "<string>",
  "signatureDone": true,
  "submissionSlug": "<string>",
  "tenantId": "<string>"
}

Autorisierungen

Authorization
string
header
erforderlich

Value for the Authorization header parameter.

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
email
string
firstName
string
lastName
string
offer
string<iri-reference>
Beispiel:

"https://example.com/"

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

"not_started"

signingLog
string[]
signedDocument
string<iri-reference> | null
Beispiel:

"https://example.com/"

Link to the offer for the recipient

Beispiel:

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

signingName
string
signingNameRole
string
signatureDone
boolean
submissionSlug
string | null
tenantId
string