FAfabric
Attributes

Update a specific attribute

Updates a specific attribute by attributeId

put/api-offers/attributes/{attributeId}

Request

Path parameters

attributeIdnumber required
Example:100002

ID of the attribute to be updated

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Request body

namestring required

The attribute name.

valuesstring[] required

The attribute values corresponding to the name.

Example request

{
  "name": "Brand",
  "values": [
    "CHS",
    "SOMA",
    "WHBM"
  ]
}

Response

OK

_idstring

A 24-character system-generated attribute ID.

attributeIdnumber

A unique identifier of the attribute, for external use.

namestring

The attribute name.

valuesstring[]

The attribute values.

deletedboolean

A flag indicating the deletion status of the attribute. Set it to true to indicate the attribute is deleted and false to indicate otherwise.

createdAtstring date-time

The time of attribute creation, in UTC format.

updatedAtstring date-time

The time when the attribute was last updated, in UTC format.

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "attributeId": 100002,
  "name": "Brand",
  "values": [
    "CHS",
    "SOMA",
    "WHBM"
  ],
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.