DEdefaulr
DataAttributes

Create a data attribute

Changed on

Create a new data attribute. Only admins can create data attributes.

post/dataAttributes.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/dataAttributes.create
  • 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

namestring required

Name of the data attribute.

descriptionstring

Description of the data attribute.

dataType'string' | 'number' | 'boolean' | 'list' required

The data type of the attribute value.

pinnedboolean

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

Example request

{
  "name": "Status",
  "description": "The current status of the document."
}

Response

OK

Example response

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

Changes