DEdefaulr
DataAttributes

Update a data attribute

Changed on

Update an existing data attribute. Only admins can update data attributes. Note that the dataType cannot be changed after creation.

post/dataAttributes.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/dataAttributes.update
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the data attribute.

namestring required

Name of the data attribute.

descriptionstring

Description of the data attribute.

pinnedboolean

Whether the data attribute is pinned to the top of document.

Example request

{
  "name": "Status"
}

Response

OK

Example response

{
  "data": {
    "name": "Status",
    "description": "The current status of the document."
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes