Actions103
- Calendar Actions
- Common Data Actions
- Contacts Actions
- Contracts Actions
- Credit Notes Actions
- Customers Actions
- Custom Fields Actions
- Estimates Actions
- Expenses Actions
- Invoices Actions
- Items Actions
- API Keys Actions
- Leads Actions
- Milestones Actions
- Payments Actions
- Projects Actions
- Property Actions
- Proposals Actions
- Staff Actions
- Subscriptions Actions
- Tasks Actions
- Tickets Actions
- Timesheets Actions
API Keys → Suspend
AI-generatedSummary
Suspend an existing API key by sending a JSON payload that specifies the key to be suspended to the BackOffice ERP API.
Inputs
- Payload (JSON) (required) — Provide a JSON payload including the API key to suspend, for example {"key":"existing-key"}. This JSON can be entered manually or generated automatically by the AI assistant based on the conversation context.
Output shape
a single JSON response object indicating the result of the suspension request.
The operation sends a POST request to the 'key/suspend' endpoint with the provided JSON payload. The output contains the API response from the BackOffice ERP API. If multiple items are processed, the output is an array of such response objects corresponding to each input item.