Sign in
Objects

Create or update a single custom attribute

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.

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}

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

Changed in 4 of the 115 revisions of this API.43

  • 4846c539a52021See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

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

      request-property-one-of-removed

    • ○

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

      request-property-one-of-added

  • ef2ed4fdc37611See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

  • 7d6c145c0be01See the full diff
    • ○

      endpoint added

      endpoint-added

  • c6aaf3632e481See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog