PATCH
/
v3
/
collections
/
{identifier}
/
fields
/
{datapoint_identifier}
Update data field for a collection assosciated with a data point.
curl --request PATCH \
  --url https://{region}.affinda.com/v3/collections/{identifier}/fields/{datapoint_identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "<string>",
  "fieldType": "text",
  "mandatory": true,
  "showDropdown": true,
  "displayEnumValue": true,
  "autoValidationThreshold": 0.5,
  "enableAutoValidationThreshold": true,
  "dataSource": "<string>",
  "mapping": "<string>",
  "displayRawText": "<string>"
}'
{
  "label": "<string>",
  "fieldType": "text",
  "mandatory": true,
  "showDropdown": true,
  "displayEnumValue": true,
  "autoValidationThreshold": 0.5,
  "enableAutoValidationThreshold": true,
  "dataSource": "<string>",
  "mapping": "<string>",
  "displayRawText": "<string>"
}

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required

Collection's identifier

Example:

"mEFayXdO"

datapoint_identifier
string
required

Datapoint's identifier

Example:

"XprEvgai"

Body

application/json

Data field properties to update

The body is of type object.

Response

200
application/json

Successfully updated data field.

The response is of type object.