Update Attribute

Beta

PATCH/v1/catalog/properties/{property_id}/attributes/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an attribute.

Items reference attributes by ID, so changing the value renames the attribute everywhere it is already assigned.

Permissions requiredValues:properties:update

The role behind your API key or agent must grant every one of these permissions.

property_idstring

The property the attribute belongs to.

idstring

Attribute ID.

valueoptional string

The selectable value this attribute represents, such as Red.

Must be non-blank and unique across all attributes in the account, not just within the property.

coloroptional stringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

sort_orderoptional integer

New position of this attribute relative to its siblings within the property, starting at 1.

Must be at most the property's current attribute count; the attributes between the old and new positions shift to make room.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's or a volume discount's attributes list.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name of the property, such as Color or Size.

Unique within the account.

attributeslistnullable

The selectable values defined under this property.

Listed in the order the attributes are arranged within the property, first to last.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of attribute

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's or a volume discount's attributes list.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name of the property, such as Color or Size.

Unique within the account.

attributeslistnullable

The selectable values defined under this property.

Listed in the order the attributes are arranged within the property, first to last.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of attribute

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for Update Attribute

Update Attribute

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const attribute = await client.catalog.properties.attributes.update('at_rf1w295jt5ia', {
  property_id: 'pp_fhnnvtt3q3ov',
  color: 'blue',
  sort_order: 2,
  value: 'Blue',
});

console.log(attribute.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const attribute = await client.catalog.properties.attributes.update('at_rf1w295jt5ia', {
  property_id: 'pp_fhnnvtt3q3ov',
  color: 'blue',
  sort_order: 2,
  value: 'Blue',
});

console.log(attribute.id);

200 example

{
  "id": "at_rf1w295jt5ia",
  "object": "attribute",
  "value": "Premium",
  "color": "red",
  "sort_order": 1,
  "property": {
    "id": "pp_fhnnvtt3q3ov",
    "object": "property",
    "name": "Color",
    "attributes": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "at_rf1w295jt5ia",
  "object": "attribute",
  "value": "Premium",
  "color": "red",
  "sort_order": 1,
  "property": {
    "id": "pp_fhnnvtt3q3ov",
    "object": "property",
    "name": "Color",
    "attributes": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Attribute

Authorization

Path Parameters

Request Body

Returns

Responses