v1

latestOpenAPI 3.0.32026-07-1416063.7 KB

Update an Existing Attribute

This endpoint creates a new attribute and associates it with the client.

put/attributes/{id}

Path parameters

idinteger required

The ID used to identify the attribute.

Request body

namestring required

The name used to easily identify the attribute. Allowed values are between 2 and 255 characters.

statusstring required

The status of the attribute. Allowed values are active and inactive.

typestring required

The attribute type defining the data structure. Allowed values are email, phone, string, zip, zip_plusfour, numeric_only, alpha_only, alphanumeric_only, boolean.

lengthinteger required

The length of characters allowed for the attribute. Allowed values are between 1 and 255.

values_typestring required

The value type allowed for the attribute. Allowed values are open and predefined.

Response

200

idinteger

namestring

typestring

scopestring

lengthinteger

values_typestring

{"stackTrail":"paths:/attributes/{id}:put:responses:200:content:application/json:schema:properties:valid_values","oasType":"schema","type":"unknown"}

statusstring

subtypestring

Example response

{
  "id": 100,
  "name": "Email Address",
  "type": "string",
  "scope": "client",
  "length": 100,
  "values_type": "open",
  "status": "active",
  "subtype": "string"
}