DELETE
/
api
/
v2
/
public
/
config
/
field
/
:fieldId
curl --request DELETE \
  --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": "670fcb9e023ebc1f370c5139",
    "name": "YourName",
    "has_dynamic_map_fields": false,
    "field_type": "text",
    "options": [],
    "dynamic_slot_identifier": "text",
    "hidden": false
}

This API deletes the specified configuration field for a given linked account.

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

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

field_type
string

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

options
array

Options array for the select field, or map field.

dynamic_slot_identifier
string

Identifier for the dynamic slot.

hidden
boolean

Whether the field is hidden or not.

{
    "required": false,
    "id": "670fcb9e023ebc1f370c5139",
    "name": "YourName",
    "has_dynamic_map_fields": false,
    "field_type": "text",
    "options": [],
    "dynamic_slot_identifier": "text",
    "hidden": false
}