Chilkat Online Tools

Python / Support API / Update Organization Field

Back to Collection Items

import sys
import chilkat

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat.CkHttp()

http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/organization_fields/:organization_field_id")
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.header())
    print("Failed.")

    sys.exit()

# 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 = jResp.stringOf("organization_field.key")
v_Type = jResp.stringOf("organization_field.type")
Title = jResp.stringOf("organization_field.title")
Active = jResp.stringOf("organization_field.active")
Created_at = jResp.stringOf("organization_field.created_at")
Description = jResp.stringOf("organization_field.description")
Id = jResp.stringOf("organization_field.id")
Position = jResp.stringOf("organization_field.position")
Raw_description = jResp.stringOf("organization_field.raw_description")
Raw_title = jResp.stringOf("organization_field.raw_title")
Regexp_for_validation = jResp.stringOf("organization_field.regexp_for_validation")
Relationship_target_type = jResp.stringOf("organization_field.relationship_target_type")
System = jResp.stringOf("organization_field.system")
Tag = jResp.stringOf("organization_field.tag")
Updated_at = jResp.stringOf("organization_field.updated_at")
v_Url = jResp.stringOf("organization_field.url")
i = 0
count_i = jResp.SizeOfArray("organization_field.custom_field_options")
while i < count_i :
    jResp.put_I(i)
    name = jResp.stringOf("organization_field.custom_field_options[i].name")
    value = jResp.stringOf("organization_field.custom_field_options[i].value")
    id = jResp.stringOf("organization_field.custom_field_options[i].id")
    position = jResp.stringOf("organization_field.custom_field_options[i].position")
    raw_name = jResp.stringOf("organization_field.custom_field_options[i].raw_name")
    url = jResp.stringOf("organization_field.custom_field_options[i].url")
    i = i + 1

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}"
    }
  ]
}