Delete Site Setting

Deletes a setting from a Square Online site. This operation permanently removes the specified settings file from the site directory of the site.

DELETE /v2/sites/{site_id}/settings?name={file_name}

Permissions: ONLINE_STORE_CUSTOM_THEME_WRITE

Path parameters

Name Type Description
site_id string Required The ID of the site.

Query parameters

Name Type Description
name string The name of the settings file to delete (without the file extension).

Response fields

Name Type Description
errors Error [ ] Any errors that occurred during the request.

Example request

curl https://connect.squareup.com/v2/sites/site_id0/settings?name=settings_file_name1 \
  -X DELETE \
  -H 'Square-Version: 2023-09-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Example response

{}