Unicode C++ / Support API / Create or Update a User Field Option
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false);
}
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/user_fields/:user_field_id/options
Postman Collection Item JSON
{
"name": "Create or Update a User Field Option",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_fields",
":user_field_id",
"options"
],
"variable": [
{
"key": "user_field_id",
"value": "<integer>"
}
]
},
"description": "Creates a new option or updates an existing option for the given drop-down user field.\n\nTo update an option, include the id of the option in the `custom_field_option` object. Example: `{\"custom_field_option\": {\"id\": 10002, \"name\": \"Pineapples\", ... }`. If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.\n\n#### Response\n\nReturns one of the following status codes:\n\n- 200 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option already exists in the database\n- 201 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option is new\n\n#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_fields",
":user_field_id",
"options"
],
"variable": [
{
"key": "user_field_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_field_option\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
},
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_fields",
":user_field_id",
"options"
],
"variable": [
{
"key": "user_field_id"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_field_option\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}