profile:write, which you grant on the Authorize access page when you connect.
This page is generated from the connector’s tool catalogue. It describes 1 tool. Every tool reads or writes only your own account.
Permissions this page needs
profile:write: Update your profile preferences, and propose booking page changes you approve
actions.cancel
Your agent host shows this tool as “Withdraw a proposed action”.
What this changes: Withdraw an action this client proposed for the authenticated student, while it is still waiting for the student’s decision and no execution has started.
Permissions: This tool needs profile:write, which the Authorize access page describes as “Update your profile preferences, and propose booking page changes you approve”.
Risk: safe_write. This tool withdraws a review request the agent proposed and changes no setting of yours. It does not ask you to approve first, because a withdrawal writes nothing to your account and can only happen while you have not decided.
Input
Example call
actions.cancel input
Result
A result is never larger than 4,096 bytes. This tool’s result takes one of these 2 forms, and one call returns exactly one of them. The field named beside each form below says which one you are looking at. Open a form to read its top-level fields.Shape 1, where status is failed
Shape 1, where status is failed
Top-level fields
Shape 2, where status is cancelled
Shape 2, where status is cancelled
Top-level fields
Outcomes
A call carries one of these two codes, andOPERATION_CANCELLED is the success.