Choice Field Values

Choice Field Values

POST {{host}}/api/rest/v4/schema/choicefieldvalues/{{fieldId}}

Use this endpoint to add new choice values to an existing choice field in the schema.

This is the only POST operation available in the Schema APIs and the only way to programmatically update the schema. All other schema changes must be made through Object Management on the DealCloud app.

Params

NameParam TypeData TypeValues
fieldIdpathint2038
choiceValuesToAppendbodyArray[string]["Choice 3", "Choice 4"]

Request

POST {{host}}/api/rest/v4/schema/choicefieldvalues/{{fieldId}}
Authorization: Bearer {{token}}
 
[
    "Choice 3",
    "Choice 4"
]

Response

Success

200 OK

Error

400 Bad Request
{
  "message": "Field with provided id is not of type Choice: 2204"
}