PATCH
/
v3
/
data_point_choices
/
{id}
Update a data point choice
curl --request PATCH \
  --url https://{region}.affinda.com/v3/data_point_choices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dataPoint": "XprEvgai",
  "organization": "mEFayXdO",
  "collection": "mEFayXdO",
  "label": "USD",
  "value": "USD",
  "synonyms": [
    "<string>"
  ],
  "description": "<string>"
}'
{
  "id": 1,
  "label": "USD",
  "value": "USD",
  "synonyms": [
    "<string>"
  ],
  "description": "<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

​
id
integer
required

Data point choice's ID

Required range: x >= 1
Example:

1

Body

application/json

Data point choice to update

​
dataPoint
string

Uniquely identify a data point.

Example:

"XprEvgai"

​
organization
string

Uniquely identify an organization.

Example:

"mEFayXdO"

​
collection
string

Uniquely identify a collection.

Example:

"mEFayXdO"

​
label
string
Example:

"USD"

​
value
string
Example:

"USD"

​
synonyms
string[] | null
​
description
string | null

Response

Successfully updated data point choice.

​
id
integer
required

Data point choice's ID

Required range: x >= 1
Example:

1

​
label
string
required
Example:

"USD"

​
value
string
required
Example:

"USD"

​
synonyms
string[] | null
​
description
string | null