Chilkat Online Tools

Powershell / Support API / Create or Update Ticket Field Option

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

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

$resp = $http.QuickRequest("POST","https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id/options")
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "custom_field_option": {
#     "name": "<string>",
#     "value": "<string>",
#     "id": "<integer>",
#     "position": "<integer>",
#     "raw_name": "<string>",
#     "url": "<string>"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$Name = $jResp.StringOf("custom_field_option.name")
$Value = $jResp.StringOf("custom_field_option.value")
$Id = $jResp.StringOf("custom_field_option.id")
$Position = $jResp.StringOf("custom_field_option.position")
$Raw_name = $jResp.StringOf("custom_field_option.raw_name")
$v_Url = $jResp.StringOf("custom_field_option.url")

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id/options

Postman Collection Item JSON

{
  "name": "Create or Update Ticket Field Option",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_fields/:ticket_field_id/options",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_fields",
        ":ticket_field_id",
        "options"
      ],
      "variable": [
        {
          "key": "ticket_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates or updates an option for the given drop-down ticket field.\n\nTo update an option, include the id of the option in the `custom_field_option` object. Example:\n\n`{\"custom_field_option\": {\"id\": 10002, \"name\": \"Pineapples\", ... }`\n\nIf 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/ticket_fields/{ticket_field_id}/options.json` if the ticket field option already exists in the database\n- 201 with `Location: /api/v2/ticket_fields/{ticket_field_id}/options.json` if the ticket field option is new\n\n#### Allowed For\n\n* Admins\n\n#### Rate Limit\nYou can make 100 requests every 1 minute using this endpoint.\nThe rate limiting mechanism behaves as described in\n[Monitoring your request activity](/api-reference/ticketing/account-configuration/usage_limits/#monitoring-your-request-activity) in the API introduction.\n\n#### Field Option Limits\n\n* 2000 options per ticket field\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/ticket_fields/:ticket_field_id/options",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_fields",
            ":ticket_field_id",
            "options"
          ],
          "variable": [
            {
              "key": "ticket_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/ticket_fields/:ticket_field_id/options",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_fields",
            ":ticket_field_id",
            "options"
          ],
          "variable": [
            {
              "key": "ticket_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}"
    }
  ]
}