Update Site Preference Group

PATCH/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Update Site Preference Group action (under Preferences (Data API)).
Fill in the fields below, then reference the result from later steps as {{updateSitePreferenceGroup.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

groupIdstringrequired

The preference group ID.

instanceTypestringrequired

The instance type for which to read or update preferences.

One ofstagingdevelopmentsandboxproduction

Query parameters

maskPasswordsboolean

The preference values of type Password are masked when set.

Default false

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Request body

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

siteobject

idanyrequired

The ID of the site.

displayNameobject

descriptionobject

customerListLinkany

The link to the customer list

inDeletionboolean

Specifies whether the site status is in deletion (true) or not (false)

storefrontStatusstring

Status of the storefront

One ofonlinemaintenanceto_be_deletedprotected

siteCatalogIdstring

The catalog bound to the given site.

cartridgesstring

The cartridge names assigned to a site delemited by ':'.

creationDatestring (date-time)

The timestamp when the site was created.

lastModifiedstring (date-time)

The timestamp when the site was last modified.

json

{
  "site": {
    "id": null,
    "displayName": {},
    "description": {},
    "customerListLink": null,
    "inDeletion": false,
    "storefrontStatus": "online",
    "siteCatalogId": "storefront-catalog-m-en",
    "cartridges": "app_storefront_core:app_storefront_base",
    "creationDate": "2024-01-15T10:00:00.000Z",
    "lastModified": "2024-10-14T15:30:00.000Z"
  }
}

Response

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