Dukan icon

Dukan

Interact with the Dukan API

City Or Municipality → Update City

AI-generated

Summary

Update an existing city or municipality in the Dukan system by specifying its MongoDB ObjectId and providing new data either as individual fields or a JSON object.

Inputs

  • City ID (required) — MongoDB ObjectId of the city to update.
  • Use JSON — Toggle whether to provide the city data as JSON or individual fields.
  • JSON — JSON object defining the city data to update, required if Use JSON is enabled.
  • City Name — New name for the city.
  • City Custom ID — Custom identifier for the city.
  • Is Active — Boolean to set whether the city is active.
  • Force Custom Auth Header — Whether to use a custom API key instead of configured credentials.
  • Custom API Key — Custom API key used if Force Custom Auth Header is enabled.
  • Force Custom Base URL — Whether to use a custom base URL instead of the one from credentials.
  • Custom Base URL — Custom base URL to use for API requests if Force Custom Base URL is enabled.

Output shape

a single updated city record as returned by the Dukan API

The operation sends an HTTP PATCH request with the updated city data. If Use JSON is true, the JSON string is parsed and sent as the body; otherwise, only provided fields (City Name, City Custom ID, Is Active) are sent. Authentication and base URL can be overridden per request. Errors from the API are returned if the update fails.

Links

Discussion