Objects

Create or update a single custom attribute

Changed on

Upsert a single custom attribute identified by name. The name is taken from the URL path (URL-encoded). It must be 1-127 characters, must not contain a slash or any control character; spaces, dots, dashes, colons and unicode are allowed. Names starting with $ are reserved for server-side attributes and are rejected (400).

A string value is stored as plain text. A JSON object or array value is stored as a structured value: it is serialized in canonical form (compact, sorted keys) and the attribute is marked with the json flag, so scripts receive it as a hash map or array and JSON representations return it as an object or array rather than as text.

put/v1/objects/{object-id}/custom-attributes/{name}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/custom-attributes/{name}
  • Auth
    HTTP bearer

Path parameters

object-idinteger required
namestring required

Custom attribute name (URL-encoded).

Request body

inheritableboolean

Whether the attribute is inherited by child objects. Defaults to false.

Response

Attribute created or updated.

namestring
inheritableboolean

Changes

    • breaking

      the request property became not nullable

    • breaking

      removed subschema #1 subschema #3 from the request property oneOf list

    • info

      added subschema #1 subschema #3 to the request property oneOf list

    • breaking

      response property value list-of-types was widened by adding types array and object to media type application/json of response 200

    • info

      request property list-of-types was widened by adding types array and object to media type application/json