Create Custom Field

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2025-01-01.

It is scheduled for sunset on 2027-01-31.

Description#

Create a Custom Field on a Record Type. This endpoint is deprecated, please use the partiallyUpdateCustomSchema endpoint instead.

POST /prototype/platform/recordTypes/{recordType}/customFields

Required OAuth Scopes

No OAuth scopes are required to use this endpoint.

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
recordType	path	string	true	The Record Type upon which to operate
body	body	CustomField	true	A Custom Field to create

Enumerated Values#

Parameter	Value
recordType	`Document`
recordType	`Presentation`
recordType	`Spreadsheet`
recordType	`Section`
recordType	`Slide`
recordType	`Sheet`

Body parameter example#

{
  "id": "com.workiva.gsr.legal_entity",
  "schema": {
    "description": "string",
    "enum": [
      null
    ],
    "format": "date-time",
    "maxLength": 0,
    "maximum": 0,
    "minLength": 0,
    "minimum": 0,
    "pattern": "/regex/",
    "reference": {
      "$comment": "string",
      "cardinality": "one",
      "description": "string",
      "field": "/json/pointer",
      "referenceType": "ReadCache",
      "resource": "Document"
    },
    "rhp_position_hint": 0,
    "state": "Draft",
    "title": "string",
    "type": "boolean"
  }
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields', headers = headers)

print(r.json())