Field API Names ​

API payloads reference fields by their API name, not their display label. The API name is a stable, machine-friendly identifier set when the field is created and visible in the dashboard.

Lead field API names ​

  1. Go to Settings → Lead Fields.
  2. Click the field whose API name you need.
  3. Open Properties.
  4. Copy the value next to API name.

Standard fields have predictable API names: name, phone, email, rating, status, assignee. Custom fields use whatever API name was configured when the field was added.

If the workspace uses field categories, the list on that screen is grouped into sections — Primary, Others, and any the workspace has added. The grouping is presentational only: a field's API name and its behaviour in a payload are the same whichever category it sits in. GET /custom-fields returns each field's category label alongside its API name.

Custom action field API names ​

Each custom action defines its own set of fields, with their own API names.

  1. Go to Settings → Custom Actions.
  2. Click the action.
  3. For each field in the action's schema, the API name is shown in the field's properties panel.

Using API names in a payload ​

API names are the keys inside the fields object on a lead or action payload.

json
{
  "fields": {
    "name": "Jane Doe",
    "phone": "919999999999",
    "contact_source": "Website",
    "deal_size": 1000
  },
  "actions": [
    {
      "type": "ACTION_1001",
      "fields": {
        "note": "Site visit completed",
        "outcome": "Interested"
      }
    }
  ]
}

TIP

Display labels can be changed in the dashboard without affecting integrations. API names are stable — they do not change when a field is renamed.