delphiDll / Support API / Update Organization Field
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
name: PWideChar;
value: PWideChar;
id: PWideChar;
position: PWideChar;
raw_name: PWideChar;
url: PWideChar;
Key: PWideChar;
v_Type: PWideChar;
Title: PWideChar;
Active: PWideChar;
Created_at: PWideChar;
Description: PWideChar;
Id: PWideChar;
Position: PWideChar;
Raw_description: PWideChar;
Raw_title: PWideChar;
Regexp_for_validation: PWideChar;
Relationship_target_type: PWideChar;
System: PWideChar;
Tag: PWideChar;
Updated_at: PWideChar;
v_Url: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequest(http,'PUT','https://example.zendesk.com/api/v2/organization_fields/:organization_field_id');
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "organization_field": {
// "key": "<string>",
// "type": "<string>",
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "custom_field_options": [
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// }
// ],
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_description": "<string>",
// "raw_title": "<string>",
// "regexp_for_validation": "<string>",
// "relationship_filter": {},
// "relationship_target_type": "<string>",
// "system": "<boolean>",
// "tag": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Key := CkJsonObject__stringOf(jResp,'organization_field.key');
v_Type := CkJsonObject__stringOf(jResp,'organization_field.type');
Title := CkJsonObject__stringOf(jResp,'organization_field.title');
Active := CkJsonObject__stringOf(jResp,'organization_field.active');
Created_at := CkJsonObject__stringOf(jResp,'organization_field.created_at');
Description := CkJsonObject__stringOf(jResp,'organization_field.description');
Id := CkJsonObject__stringOf(jResp,'organization_field.id');
Position := CkJsonObject__stringOf(jResp,'organization_field.position');
Raw_description := CkJsonObject__stringOf(jResp,'organization_field.raw_description');
Raw_title := CkJsonObject__stringOf(jResp,'organization_field.raw_title');
Regexp_for_validation := CkJsonObject__stringOf(jResp,'organization_field.regexp_for_validation');
Relationship_target_type := CkJsonObject__stringOf(jResp,'organization_field.relationship_target_type');
System := CkJsonObject__stringOf(jResp,'organization_field.system');
Tag := CkJsonObject__stringOf(jResp,'organization_field.tag');
Updated_at := CkJsonObject__stringOf(jResp,'organization_field.updated_at');
v_Url := CkJsonObject__stringOf(jResp,'organization_field.url');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'organization_field.custom_field_options');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
name := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].name');
value := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].value');
id := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].id');
position := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].position');
raw_name := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].raw_name');
url := CkJsonObject__stringOf(jResp,'organization_field.custom_field_options[i].url');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_fields/:organization_field_id
Postman Collection Item JSON
{
"name": "Update Organization Field",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields",
":organization_field_id"
],
"variable": [
{
"key": "organization_field_id",
"value": "<integer>"
}
]
},
"description": "#### Updating a Drop-down (Tagger) Field\n\nDrop-down fields return an array of `custom_field_options` which specify the name, value, and order of drop-down options. When updating a drop-down field, note the following information:\n\n- All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations\n- To create a new option, pass a null `id` along with the `name` and `value`\n- To update an existing option, pass its `id` along with the `name` and `value`\n- To reorder an option, reposition it in the `custom_field_options` array relative to the other options\n- To remove an option, omit it from the list of options upon update\n\n#### Example Request\n\n```bash\ncurl https://{subdomain}.zendesk.com/api/v2/organization_fields/{organization_field_id}.json \\\n -H \"Content-Type: application/json\" -X PUT \\\n -d '{\"organization_field\": {\"custom_field_options\": [{\"id\": 124, \"name\": \"Option 2\", \"value\": \"option_2\"}, {\"id\": 123, \"name\": \"Option 1\", \"value\": \"option_1\"}, {\"id\": 125, \"name\": \"Option 3\", \"value\": \"option_3\"}]}}' \\\n -v -u {email_address}:{password}\n```\n#### Allowed for\n\n* Admins\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields",
":organization_field_id"
],
"variable": [
{
"key": "organization_field_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"organization_field\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
