Skip to navigation
RESTAdminContentCustom Template Associations

Upsert Custom Template Associations

Upsert new custom template associations data across all storefronts. If an existing record is found for the combination of channel ID, entity ID, and type, the existing record will be overwritten with the new template.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
ThemesRead-onlystore_themes_read_only
ThemesManagestore_themes_manage

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Request

This endpoint expects a list of objects.
channel_idintegerRequired
entity_typeenumRequired
Allowed values:
entity_idintegerRequired
file_namestringRequired

Response

Success response for batch upsert of custom template associations

Errors

422
Unprocessable Entity Error