Create Or Update Domains

  • Published on Jan 19, 2026
  • 3 minute(s) read
  • PP
 Prev
Post
/amazeApiRest/rest/v1/catalogs/1/domains

This API allows clients to create new domains or update existing ones in Product Content Cloud (PCC). It supports sending domain definitions, attribute schemas, records, metadata, and digital assets in a single payload. This endpoint is used for onboarding new domain configurations, maintaining domain content, and synchronizing external master data into PCC. 

Header parameters
X-Access-Token
string
ExampleAHiWIfzgk1agkj29iosfL47m1ZEE30lEXbZksjCF7BhZTh1pQz220S70
X-Customer-Code
string
ExampleAPITST
X-Oauth-Provider
string
ExampleCODIFYD
Content-Type
string
Exampleapplication/json
X-Requested-With
string
ExampleXMLHttpRequest
x-authorization-mode
string
Examplepassword
X-Client-Secret
string
Example6CHewppLoyVJIVwDAkwEG9J1SRySiISh
Body parameters
object
Example[ { "domainName": "2018-11-01", "domainNameBaseLocale": "en_us", "isRestrictedValueList": true, "product360DisplayLocation": "individual Tab", "domainAttributes": [ { "attributeName": "brand impression1", "attributeDataType": "dateTime", "attributeConstraintIsRequired": true, "attributeConstraintEnforceDataType": "y", "attributeConstraintMinimumValueOrLength": "0", "attributeConstraintMaximumValueOrLength": "0", "attributeConstraintAllowMultivalue": "y", "attributeConstraintEnforceListOfValue": "y", "attributeListOfValues": [ { "displayOrder": "0", "valueInList": "2025-12-11" } ] }, { "attributeName": "sid1", "attributeDataType": "String", "attributeConstraintIsRequired": false, "attributeConstraintEnforceDataType": false, "attributeConstraintMinimumValueOrLength": "-1.2", "attributeConstraintMaximumValueOrLength": "0.00000", "attributeConstraintAllowMultivalue": "1", "attributeConstraintEnforceListOfValue": "1", "attributeListOfValues": [ { "displayOrder": "0", "valueInList": "string1" }, { "displayOrder": "3", "valueInList": "sring1" } ] } ], "domainRecords": [ { "domainRecord": "Adidas", "recordAttributes": [ { "attributeName": "brand impression1", "attributeData": "123" }, { "attributeName": "brand impression1", "attributeData": "345" } ] }, { "domainRecord": "Nike", "recordAttributes": [ { "attributeName": "sid1", "attributeData": "Never settle" }, { "attributeName": "sid1", "attributeData": "Just do it" } ], "recordRelationships": [ { "domainNameRelatedTo": "Brand1", "domainRecordRelatedTo": "Adidas", "relationshipVerbiageFromTo": "is test1", "relationshipVerbiageToFrom": "is test2" } ], "recordDigitalAssets": [ { "digitalAssetName": "", "digitalAssetType": "", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/test/SG001/ea6cfb72-4248-4b5c-99ee-7f89ce8b8304.jpeg", "digitalAssetThumbnailPublicURL": "", "primary": false }, { "digitalAssetName": "", "digitalAssetType": "", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/PCC24/67055314-c257-48f0-9832-1cb7977bb3a0.png", "digitalAssetThumbnailPublicURL": "", "primary": true } ] } ], "domainMetaTags": [ { "name": "test18", "description": "this is meta tag." }, { "name": "test29", "description": "this is meta tag." } ], "domainMetaAttributes": [ { "domainMetaAttributeDescription": " ", "domainMetaAttributeName": "sid19nov", "domainMetaAttributeValue": "sid19nov" } ], "domainDigitalAssets": [ { "digitalAssetName": "", "digitalAssetType": "", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/test/SG001/ea6cfb72-4248-4b5c-99ee-7f89ce8b8304.jpeg", "digitalAssetThumbnailPublicURL": "", "primary": true }, { "digitalAssetName": "", "digitalAssetType": "", "digitalAssetPublicUrl": "", "digitalAssetThumbnailPublicURL": "", "primary": false } ], "pcckeyDomainIdentifier": 0 } ]

Request Body Parameters


domainName (string)

It defines what the domain represents (such as “Supplier”, “Packaging Specs”, or “Nutritional Claims”) and acts as the primary label under which all of the domain’s attributes, records, and digital assets are organized.
This is the key identifier for the domain.

domainNameBaseLocale (string)

Language/locale for the domain name (e.g., "en_us").
Useful for multi-language implementations.

isRestrictedValueList (strinng) 

Indicates whether attribute values must come from a predefined LOV (List of Values)

  • "true" → Must use LOV

  • "false" → Free-text values allowed

    Datatype: ("true"/"false", though logical boolean)

product360DisplayLocation (string)

Indicates to the PCC system in which section or tab of the Product360 screen should show the attributes and records belonging to this domain.
 Example: "Common Tab", "Individual Tab".

PCCKeyDomainIdentifier (number)

Unique internal identifier for the domain inside PCC (Product Content Cloud).

Domain Attribute Schema (domainAttributes)

Datatype: Array<DomainAttribute>

Each DomainAttribute object includes:

attributeName (string)

The name of the attribute that belongs to this domain (e.g., “Supplier ID”, "Supplier Name").

attributeDataType (string)

Expected datatype of the attribute.
Common values: "String", "Number", "DateTime".

attributeConstraintIsRequired (string) 

Whether this attribute must be provided in every record.

Datatype: String ("true" / "false")

attributeConstraintEnforceDataType (string)

Whether the value must strictly match the defined datatype.

Datatype: String ("true" / "false")

attributeConstraintAllowMultivalue(string)

Specifies whether a single record is allowed to store more than one value for this attribute. If this setting is enabled, the attribute can behave like a multi-select field, allowing the record to hold multiple entries of the same attribute instead of being limited to just one.  

Datatype: String ("true" / "false")

attributeConstraintEnforceListOfValue(string)

Whether only allowed values from an attribute LOV can be used.

Datatype: String ("true" / "false") 

Domain Records (domainRecords)

Datatype: Array<DomainRecord>

Each DomainRecord object includes:

domainRecord (string)

Primary unique identifier for the record (e.g., "SUP-001").
 Often acts like a key or record name.

recordAttributes

Actual values assigned to the attribute schema defined earlier.

Datatype: Array<RecordAttribute>

Each RecordAttribute contains:

attributeName (string)

Name of the attribute being set.

attributeData (string)

Actual assigned value for the record.

Responses
200

Successful response

Response Body Parameters

Your response contains a single top-level object with one property:

responseSummary (object)

 Contains a summary of the domain-loading operation, including counts of successes, failures, updates, and lists of affected domains.

Inside responseSummary

Below is each parameter inside responseSummary, described with datatype + meaning:

Count of Domains Sent In Payload (number)

 Total number of domains that were included in the input POST payload.

Count of Domains Successfully Loaded Into PCC (number)

 Number of domains that were successfully processed (inserted or updated) in the Product Content Cloud (PCC).

Count of Domains Which Errored Entirely (number)

Number of domains that failed completely — meaning no part of the domain could be processed.

Count of Domains Which Errored Partially (number)

Number of domains that were only partially processed due to record or attribute-level errors.

Count of Domains Newly Added (number)

Number of domains that were created for the first time in PCC.

Count of Domains Updated (number)

Number of domains that already existed and were updated, not newly created.

Count of Domains New DA (number)

Count of domains for which new Digital Assets (DA) were added during the operation.

Newly Added Domains 

List of domain names that were newly added in this operation.

Datatype: Array<String>

Updated Domains

List of domain names that were updated.

Datatype: Array<String>