Custom Fields

Update a custom field

Updates an existing custom field definition and returns the updated field.

patch/v1/custom-fields/{id}

Request

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

Path parameters

idstring required

Request body

labelstring nullable
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.