Upsert Global Element

POST /v2/sites/{site_id}/global-elements

Creates or updates a global element for a Square Online site. This operation creates a .json file under global/sections or global/containers in the site directory of the site. If a file with the specified name and type already exists, Square replaces the file.

Permissions: ONLINE_STORE_CUSTOM_THEME_WRITE

Path parameters

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

Request body

Name	Type	Description
name	string	The name of the global element file to create or update (without the file extension).
type	string	The global element type, either SECTION or CONTAINER.
properties	string	The global element properties, as an escaped JSON string. This value represents the contents of the file.

Response fields

Name	Type	Description
errors	Error [ ]	Any errors that occurred during the request.
global_element	SiteGlobalElement	The new or updated global element.

Example request

curl https://connect.squareup.com/v2/sites/site_id0/global-elements \
  -X POST \
  -H 'Square-Version: 2023-09-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "header",
    "type": "SECTION",
    "properties": "{ \"props\": { \"logo_image\": \"https:\/\/www.squareswag.xyz\/uploads\/b\/790312eec987d204998d01117fa46c52fa2bf79a9ab868f2ed52c877e442312c\/squarelogo_1676390791.png?width=400&optimize=medium\", \"nav_links\": [{ \"type\": \"external\", \"href\": \"https:\/\/squareup.com\/gift\/MLTFZ4MSE6YC9\/order\", \"label\": \"Digital Gift Cards\" }], \"buttonLink\": { \"type\": \"shopAll\", \"label\": \"Shop Now\" }, \"buttonBackground\": \"#f5fc9f\", \"buttonTextColor\": \"#000000\" }}"
  }'

Example response

{
  "global_element": {
    "name": "header",
    "type": "SECTION",
    "properties": "{ \"props\": { \"logo_image\": \"https:\/\/www.squareswag.xyz\/uploads\/b\/790312eec987d204998d01117fa46c52fa2bf79a9ab868f2ed52c877e442312c\/squarelogo_1676390791.png?width=400&optimize=medium\", \"nav_links\": [{ \"type\": \"external\", \"href\": \"https:\/\/squareup.com\/gift\/MLTFZ4MSE6YC9\/order\", \"label\": \"Digital Gift Cards\" }], \"buttonLink\": { \"type\": \"shopAll\", \"label\": \"Shop Now\" }, \"buttonBackground\": \"#f5fc9f\", \"buttonTextColor\": \"#000000\" }}"
  }
}