Mark an operation as requiring confirmation

An operation marked Requires confirmation is one that should not run on an agent's decision alone, such as a delete or a payment. You set the flag once on the API, and every gateway that serves the API applies it. What the gateway does when an agent calls the operation is set for each API key or gateway user. See Confirmation.

Review what the analysis flagged

The analysis turns the flag on for the writes it considers destructive. Until someone reviews them, the Overview tab lists them under To review.

1. In the portal, go to APIs and select your API.
2. In the Overview tab, find the row that says how many operations require confirmation and select Review. The Operations tab opens with the filter Requires confirmation only.
3. Check each operation in the list.
4. If the list is right, go back to Overview and select Looks right.

Saving an edit to any operation also clears the row.

Change the flag

1. In the Operations tab, find the operation.
2. In the Requires confirmation column, turn the switch on or off.
3. Select Save changes.
4. Select Publish in the API's header.

The change is saved to the draft. Gateways apply it when they serve the version you publish.

Turn the flag on for every operation whose effect cannot be undone from your product, because a gateway can only ask about operations that carry it. Leave it off for reads and for writes that are safe to repeat. An operation that asks every time slows the agent down.

You can also set the flag in the operation's dialog, in the Details tab.

Recipes

A recipe has no switch. It requires confirmation when any of the operations it calls does. To change it, change the flag on those operations. See Recipes.

Next steps

• Confirmation: what the client shows and how the call resumes.
• Set how a credential confirms writes: choose the behavior for a key or a user.
• Operations: the other fields of an operation.