PUT
/
offer-recipients
/
{id}
/
role
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>"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

OfferRecipient identifier

Body

The updated OfferRecipient resource
​
role
enum<string> | null
required

The role of the recipient

Available options:
read,
sign

Response

200
application/json
OfferRecipient resource updated
​
id
string
​
email
string
​
firstName
string
​
lastName
string
​
offer
string
Example:

"https://example.com/"

​
role
enum<string>
Available options:
read,
sign
​
createdAt
string
​
signingStatus
enum<string>
default:not_started
Available options:
pending,
started,
signed,
not_started,
archived
Example:

"not_started"

​
signingLog
string[]
​
signedDocument
string | null
Example:

"https://example.com/"

​
link
string

Link to the offer for the recipient

Example:

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

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

Was this page helpful?

Suggest editsRaise issue