Dukan icon

Dukan

Interact with the Dukan API

Store Client → Ban by Phone

AI-generated

Summary

Ban a client from ordering by specifying their phone number in the Dukan store system.

Inputs

  • Phone Number (required) — Phone number of the client to ban from ordering.
  • Force Custom Auth Header — Optionally use a custom API key instead of the configured credentials.
  • Custom API Key — Custom API key used when forcing custom authentication header.
  • Force Custom Base URL — Optionally use a custom API base URL instead of the configured one.
  • Custom Base URL — Custom base URL to use for API requests when forcing custom base URL.
  • Request Options — Additional options for the HTTP request like batching, proxy, SSL handling, and timeout.

Output shape

a single object representing the API response from the ban action

The output contains the API response confirming the ban by phone operation. The response structure depends on the Dukan API and may include success or error details.

Examples

Example 1: Ban a client by their phone number using default credentials and base URL

Specify the required Phone Number input; leave the Force and Custom options disabled to use node credentials and base URL.

Links

Discussion