Modifying attributes

Use the following endpoint to modify an existing attribute:
  • PATCH /admin/v1/attributes/{attributeId}

You can modify the following fields:

  • description
  • name
  • type/code
The code within type is a string that represents a TypeKey defined in the UserAttributeType typelist of available code, so you can only use a value enumerated in that list. You can access and extend this typelist in Guidewire Studio. In the base configuration for the different InsuranceSuite applications, the following typecodes are available:
  • ClaimCenter: default, account, expertise, and language
  • PolicyCenter: default, account, expertise, language, and LOB
  • BillingCenter: default

For example, the following request modifies the code for the existing attribute xc:S28_4MXQ4eF4rPt259n9z in PolicyCenter:

Command

PATCH /admin/v1/attributes/xc:S28_4MXQ4eF4rPt259n9z

Request

{
    "data": {
        "attributes": {
            "type": {
                "code": "expertise"
            }
        }
    }
}

The API responds with the updated attribute.

Response

{
    "data": {
        "attributes": {
                "description": "Auto Expertise",
                "id": "xc:S28_4MXQ4eF4rPt259n9z",
                "name": "Auto-Expertise",
                "type": {
                    "code": "expertise",
                    "name": "Expertise"
            }
        }
    }
}