Custom Fields

Update custom field

Changed on

Update an existing custom field definition. applies_to and company_ids are replaced wholesale, so send the full desired list. field_type cannot be changed after creation.

Side effects

  • If an approval workflow matches this request, DualEntry can set is_active to false.
put/public/v1/custom-fields/{custom_field_id}/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v1/custom-fields/{custom_field_id}/
  • Auth: none declared

Path parameters

custom_field_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
company_idinteger nullable

Single company id this custom field is scoped to (merged into company_ids). Omit for an org-wide field.

company_idsinteger[] nullable

List of company ids this custom field is scoped to. Omit for an org-wide field.

is_activeboolean
optionsstring[] nullable

Allowed values for single_select / multi_select fields

Response

OK

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
company_idinteger nullable
company_idsinteger[]
namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
optionsstring[] nullable
is_activeboolean required

Changes

  • a74a611f93bbRevision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

  • 074797834e54Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status