v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB

Field Configuration

Update Field Configuration Item

Partially updates a field-configuration item (PATCH semantics). Items belonging to a field configuration in another organization return 404.

patch/field-configurations/{id}/items/{itemId}

Path parameters

idstring required

UUID of the field configuration.

itemIdstring required

UUID of the field-configuration item.

Request body

titlestring

New title. Trimmed; 1-128 characters.

contentsstring

New prompt text.

descriptionstring

Optional new description. 0-2000 characters.

promptTypestring

New prompt family.

contentTypestring

New content type hint.

responseTypestring

New response type hint.

optionsstring[]

New allowed response values.

dependsOnstring[]

New dependency list.

maxValuesinteger nullable

New maximum number of values for multi-select items.

allowLongResponseboolean nullable

Whether the analyzer may produce a longer free-text response.

extractQuotesboolean nullable

Whether the analyzer should attach supporting quotes.

analysisLevel'conversation' | 'deal' | 'lead' | 'contact' | 'account'

New analysis level.

Example request

{
  "title": "Budget Range (revised)",
  "contents": "What budget range has the customer confirmed?"
}

Response

Item successfully updated.

Example response

{
  "data": {
    "uuid": "b9e1c0a0-5a3d-4a9c-9b1e-2d6f4b7a1c11__item-01",
    "fieldConfigurationUUID": "b9e1c0a0-5a3d-4a9c-9b1e-2d6f4b7a1c11",
    "title": "Budget Range",
    "category": "CRM",
    "contents": "What is the customer's stated budget range?",
    "promptType": "freeform",
    "contentType": "text"
  }
}