API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Offer Recipient
Change the role of an offer recipient
Changes the role of an offer recipient. This cannot be done, when the offer is already signed.
Required permissions:offer:write
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
Value for the Authorization header parameter.
Path Parameters
OfferRecipient identifier
Body
The updated OfferRecipient resource
Response
200
application/json
OfferRecipient resource updated
Was this page helpful?
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>"
}
Assistant
Responses are generated using AI and may contain mistakes.