ORora
project

Create Custom field

post/projects/{project_id}/custom_fields

Request

  • Base URL
    https://api.ora.pm
  • Auth
    OAuth 2
    Authorization code: https://app.ora.pm/authorize
    Token URL: https://api.ora.pm/oauth/token scopes: read, write

Request body

namestring required

Title of the custom field.

descriptionstring

Description about the custom field.

typeinteger

Type of the custom field (1 - Dropdown, 2 - Number, 3 - Text, 4 - Number, 5 - Date, 6 - Checkbox).

optionsobject[]

List with the dropdown options. (It's returned if the type is 1).

is_multilineboolean

True if the textfield is multiline. (It's returned if the type is 3).

number_formatinteger

1 - Number, 2 - USD, 3 - EUR, 4 - GBP, 5 - YEN, 6 - Percent, 7 - Custom, 8 - Unformatted (It's returned if the type is 3).

positioninteger

0 - None, 1 - Left, 2 - Right (It's returned if the type is 2).

labelstring

Which label to show, Example: %, $. (It's returned if the type is 2).

decimalsinteger

(It's returned if the type is 2).

Example request

{
  "name": "Custom field name",
  "description": "Here you can tell something about the custom field.",
  "type": 1,
  "options": [
    {
      "color": "#1B9AF7",
      "position": 0,
      "text": "Movie",
      "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e"
    }
  ],
  "is_multiline": true,
  "number_format": 1,
  "position": 1,
  "label": "$",
  "decimals": 1
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.