custom-fields

Create a custom-field definition

Plan: customFields (PRO+).

post/custom-fields/definitions

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/custom-fields/definitions
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

namestring required
entityType'PROJECT' | 'TASK' | 'PROPOSAL' required
fieldType'TEXT' | 'NUMBER' | 'DATE' | 'DROPDOWN' | 'USER' | 'CHECKBOX' required
optionsstring[]

For DROPDOWN.

requiredboolean
orderinteger

Response

Created

idstring uuid required
namestring required
entityType'PROJECT' | 'TASK' | 'PROPOSAL' required
fieldType'TEXT' | 'NUMBER' | 'DATE' | 'DROPDOWN' | 'USER' | 'CHECKBOX' required
optionsstring[]

For DROPDOWN: choice values.

requiredboolean
orderinteger
organizationIdstring uuid required

Changes

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