Update a Renewable Rental
update_renewable_rentalUsage Instructions
Update the renewable rental identified by id using the supplied request fields. Inspect the current rental and apply only the user's requested configuration changes. Requires resources.purchase; messages.readwrite is additionally required only when MarkAllSmsRead is true because the update then changes message state. There is no idempotency key. After a timeout or ambiguous failure, inspect the affected resource and sales where applicable before retrying; repeating a mutation can repeat its side effects.
Read-writeThis tool may create, modify, or delete account resources.Not open-worldThis tool operates only within Textverified.DestructiveThis tool may permanently delete or irreversibly change data. Confirm before running it.Not idempotentRepeating this tool may repeat its side effects. Check the result before retrying.
Required scopes
resources.readresources.purchaseAdditional information
Setting request.markAllSmsRead to true additionally requires messages.readwrite because it changes message state.
Warnings
This update has no idempotency key. Inspect the rental before retrying an uncertain request.
Input Schema
idstringrequiredrequestobject | nullrequireduserNotesstring | nullincludeForRenewalboolean | nullmarkAllSmsReadboolean | nulltagsarray | nullitemsstring | null{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"request": {
"type": [
"object",
"null"
],
"properties": {
"userNotes": {
"type": [
"string",
"null"
],
"maxLength": 2048
},
"includeForRenewal": {
"type": [
"boolean",
"null"
]
},
"markAllSmsRead": {
"type": [
"boolean",
"null"
]
},
"tags": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"maxItems": 5
}
}
}
},
"required": [
"id",
"request"
]
}Output Schema
succeededbooleanrequired{
"type": "object",
"properties": {
"succeeded": {
"type": "boolean"
}
},
"required": [
"succeeded"
]
}