Tool to create a new custom contact field in Freshdesk. Use when you need to add a new field definition for storing custom contact information (e.g., job title, department, customer type). The field type can be text, number, dropdown, checkbox, date, or paragraph.
typeRequiredstringType of the contact field. Valid types are: 'custom_text' (single line text), 'custom_paragraph' (multi-line text), 'custom_number' (numeric), 'custom_dropdown' (dropdown select), 'custom_checkbox' (boolean), 'custom_date' (date picker), 'custom_phone_number' (phone number), 'cu…
labelRequiredstringDisplay label for the contact field. This is what users will see in the UI.
choicesarrayList of choice options for dropdown fields. Required when field type is 'custom_dropdown'. Each choice should have a label (display text) and value (actual value stored).
positionintegerPosition/order of the field in the UI. Lower numbers appear first. Must be between 1 and 46 inclusive.
agents_can_editbooleanWhether agents can edit this field value. Required when 'required_for_agents' is True. Defaults to True if not specified.
customers_can_editbooleanWhether customers can edit this field value in the portal. Defaults to False.
editable_in_signupbooleanWhether this field can be edited during customer signup. Defaults to False.
label_for_customersRequiredstringLabel to display to customers in the portal. This field is required by the Freshdesk API.
quick_add_for_agentbooleanWhether this field appears in the quick-add form for agents (for frequently used fields). Required when 'required_for_agents' is True. Defaults to True if not specified.
required_for_agentsbooleanWhether this field is required for agents when creating or updating contacts. Defaults to False.
displayed_for_agentsbooleanWhether this field is displayed to agents. Required when 'required_for_agents' is True. Defaults to True if not specified.
required_for_customersbooleanWhether this field is required for customers in the portal. Defaults to False.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.