v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Attributes

Update attribute

Updates an attribute identified by customId. Only the fields sent in the request are changed; fields left out keep their current value. If values is sent, it replaces the attribute's full value list — any previously stored value not included is removed (omit values entirely to leave the current values untouched). Updating a customId that does not match any attribute returns 200 without applying any change — no 404 is raised.

patch/attributes/{companyId}/{customId}

Path parameters

customIdstring required

companyIdstring required

Request body

namestring nullable

Display name of the attribute.

activeboolean

Whether the attribute is active. Omit to leave the current value unchanged.

parentCustomIdstring nullable

Custom ID of the parent attribute, to nest this attribute under another one (e.g. a "City" attribute nested under "Country"). Must reference an existing attribute.

Example request

{
  "values": [
    {
      "customId": "madrid",
      "name": "Madrid",
      "parentCustomId": "spain"
    }
  ],
  "parentCustomId": "country"
}

Response

Successful Response

idstring required

Embat resource ID

customIdstring required

Client-provided custom ID