Custom Fields

Create a custom field

Creates a new custom field definition and returns it with a 201 status; the field key must be unique, and an organization defines at most 100.

post/v1/custom-fields

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/custom-fields
  • Auth: API key in header x-api-key

Request body

keystring required
labelstring required
type'text' | 'number' | 'boolean' | 'date' | 'select' required
optionsstring[] nullable
defaultValuestring nullable
isRequiredboolean nullable
sortOrderinteger nullable

Response

Success

idstring required
organizationIdstring required
keystring required
labelstring required
type'text' | 'number' | 'boolean' | 'date' | 'select' required
optionsstring[] nullable required
defaultValuestring nullable required
isRequiredboolean required
sortOrderinteger required
createdAtstring required
updatedAtstring required

Changes

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