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>"
}
Changes the role of an offer recipient. This cannot be done, when the offer is already signed.
Required permissions:offer:write
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>"
}
Value for the Authorization header parameter.
OfferRecipient identifier
The updated OfferRecipient resource
OfferRecipient resource updated
Was this page helpful?