Actions65
- Order Actions
- Product Actions
- Store Shipping Account Actions
- Delivery Companies API Actions
- Team User Actions
- Store Actions
- State Actions
- Stop Desk Actions
- City Or Municipality Actions
- Store Client Actions
- Store Coupon Actions
- Store Pro Stock Actions
State → Delete State
AI-generatedSummary
Delete a state resource in Dukan by specifying its MongoDB ObjectId.
Inputs
- State ID (required) — The MongoDB ObjectId of the state to delete.
- Force Custom Auth Header — Enable to use a custom API key instead of the node's configured credentials.
- Custom API Key — The API key to use when Force Custom Auth Header is enabled.
- Force Custom Base URL — Enable to use a custom Base URL instead of the node's credentials Base URL.
- Custom Base URL — The Base URL for API requests when Force Custom Base URL is enabled (without the /v1/external suffix).
- Request Options — Additional request options including batching parameters, proxy settings, SSL certificate validation behavior, and request timeout.
Output shape
No meaningful data returned on success; the operation primarily confirms deletion.
Operation requires the State ID. Supports batching and custom connection settings. Errors propagate if the state does not exist or deletion fails.
Examples
Example 1: Delete a single state by ID
Provide the State ID. Leave authentication and base URL as per node credentials unless override needed.