list_field_choices
Look up a Freshsales module field's definition and valid dropdown choices, including custom cf_* fields, before setting a picklist value when the ID is unknown.
Instructions
Look up a field's definition and valid dropdown choices (id -> label) for a module, including custom fields (cf_*). Use this before setting a dropdown/custom_field value you don't already know the id for — e.g. module="deals", field="deal_stage_id". IMPORTANT: for built-in fields (name has no cf_ prefix, e.g. deal_stage_id) pass the numeric id shown. For custom picklist fields (cf_* prefix) pass the label STRING (the "value" column) instead — the numeric id is silently ignored (200 response, no error, no change) for those.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field | Yes | Field name, e.g. "lead_source_id", "deal_stage_id", "cf_my_custom_field" | |
| module | Yes | Module the field belongs to |