POST
/
api
/
v2
/
public
/
config
/
field
/
:fieldId
curl --request POST \
  --url https://api.gocobalt.io/api/v2/public/config/field/:fieldId \
  --header 'linked_account_id: <linked_account_id>' \
  --header 'slug: <slug>' \
  --header 'x-api-key: <api-key>'
{
    "required": false,
    "id": "67231c960f8ac1513443c575",
    "name": "LeadStatus",
    "has_dynamic_map_fields": false,
    "dynamic_map_field_object_name": "",
    "field_type": "select",
    "options": [
        {
            "name": "New",
            "value": "NEW"
        },
        {
            "name": "Open",
            "value": "OPEN"
        },
        {
            "name": "In Progress",
            "value": "IN_PROGRESS"
        },
        {
            "name": "Bad Timing",
            "value": "BAD_TIMING"
        }
    ],
    "dynamic_slot_identifier": "dynamic:hubspot:7",
    "labels": [],
    "hidden": false
}

This API gets options for a Config Field by ID.

​
Request description

​
Headers

​
linked_account_id
string
required

Unique customer identification id. For Eg: markwood@some_email.com

​
slug
string
required

Application Slug. Eg: docusign

​
Path Parameters

​
fieldId
string
required

Unique id of field. For Eg: 67231c960f8ac1513443c75

​
Query Parameters

​
workflow_id
string

Workflow Id to filter field values. For Eg: 67fbc1ec954bde0dcae218c8

​
config_id
string

Config Id to filter field values. For Eg: 67231c960f8ac1513443c75

​
Response description

​
required
boolean

If the field is a required field.

​
id
string

Unique ID of the field

​
name
string

Field display name

​
has_dynamic_map_fields
boolean

Dynamic map fields available or not

​
dynamic_map_field_object_name
string

Name of the Dynamic Map field object.

​
field_type
string

Field input type. Expected values: text, number, select, map

​
options
array

Options array for the select field, or map field.

​
labels
array

Dynamic fields for user to map data to the map options.

​
dynamic_slot_identifier
string

Identifier for the dynamic slot.

​
hidden
boolean

Whether the field is hidden or not.

{
    "required": false,
    "id": "67231c960f8ac1513443c575",
    "name": "LeadStatus",
    "has_dynamic_map_fields": false,
    "dynamic_map_field_object_name": "",
    "field_type": "select",
    "options": [
        {
            "name": "New",
            "value": "NEW"
        },
        {
            "name": "Open",
            "value": "OPEN"
        },
        {
            "name": "In Progress",
            "value": "IN_PROGRESS"
        },
        {
            "name": "Bad Timing",
            "value": "BAD_TIMING"
        }
    ],
    "dynamic_slot_identifier": "dynamic:hubspot:7",
    "labels": [],
    "hidden": false
}