younifyd
Menu

Toggle Ocapi Caching Page Rule

Enable or disable the OCAPI Caching page rule.

PATCH/organizations/{organizationId}/zones/{zoneId}/ocapicachingpagerule

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Toggle Ocapi Caching Page Rule action (under Zones (Data API)).
  3. Fill in the fields below, then reference the result from later steps as {{toggleOcapiCachingPageRule.response.data}}.

Request

Path parameters

zoneIdstringrequired
organizationIdstringrequired

An identifier for the organization the request is being made by

Request body

Enter the body as JSON in the step's Body field.

enableOCAPICachingPageRulebooleanrequired

True to enable API Caching Page rule, false to disable.

json
{
  "enableOCAPICachingPageRule": true
}

Response

Returns 200 with an object. Read it in later steps with {{toggleOcapiCachingPageRule.response.data.<field>}}.

enableOCAPICachingPageRuleboolean

True to enable API Caching Page rule, false to disable.

json
{
  "enableOCAPICachingPageRule": true
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Toggle Ocapi Caching Page Rule — Salesforce Commerce Cloud — Documentation