SQL Server / Support API / Create Ticket Field
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://example.zendesk.com/api/v2/ticket_fields'
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "ticket_field": {
-- "type": "<string>",
-- "title": "<string>",
-- "active": "<boolean>",
-- "agent_description": "<string>",
-- "collapsed_for_agents": "<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>"
-- }
-- ],
-- "custom_statuses": [
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "solved",
-- "updated_at": "<dateTime>"
-- },
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "open",
-- "updated_at": "<dateTime>"
-- }
-- ],
-- "description": "<string>",
-- "editable_in_portal": "<boolean>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_description": "<string>",
-- "raw_title": "<string>",
-- "raw_title_in_portal": "<string>",
-- "regexp_for_validation": "<string>",
-- "relationship_filter": {},
-- "relationship_target_type": "<string>",
-- "removable": "<boolean>",
-- "required": "<boolean>",
-- "required_in_portal": "<boolean>",
-- "sub_type_id": "<integer>",
-- "system_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>"
-- }
-- ],
-- "tag": "<string>",
-- "title_in_portal": "<string>",
-- "updated_at": "<dateTime>",
-- "url": "<string>",
-- "visible_in_portal": "<boolean>"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @name nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @position nvarchar(4000)
DECLARE @raw_name nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @agent_label nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @default nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @end_user_description nvarchar(4000)
DECLARE @end_user_label nvarchar(4000)
DECLARE @status_category nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'ticket_field.type'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'ticket_field.title'
DECLARE @Active nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'ticket_field.active'
DECLARE @Agent_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Agent_description OUT, 'ticket_field.agent_description'
DECLARE @Collapsed_for_agents nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Collapsed_for_agents OUT, 'ticket_field.collapsed_for_agents'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'ticket_field.created_at'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'ticket_field.description'
DECLARE @Editable_in_portal nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Editable_in_portal OUT, 'ticket_field.editable_in_portal'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'ticket_field.id'
DECLARE @Position nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Position OUT, 'ticket_field.position'
DECLARE @Raw_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_description OUT, 'ticket_field.raw_description'
DECLARE @Raw_title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_title OUT, 'ticket_field.raw_title'
DECLARE @Raw_title_in_portal nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_title_in_portal OUT, 'ticket_field.raw_title_in_portal'
DECLARE @Regexp_for_validation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Regexp_for_validation OUT, 'ticket_field.regexp_for_validation'
DECLARE @Relationship_target_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Relationship_target_type OUT, 'ticket_field.relationship_target_type'
DECLARE @Removable nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Removable OUT, 'ticket_field.removable'
DECLARE @Required nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Required OUT, 'ticket_field.required'
DECLARE @Required_in_portal nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Required_in_portal OUT, 'ticket_field.required_in_portal'
DECLARE @Sub_type_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Sub_type_id OUT, 'ticket_field.sub_type_id'
DECLARE @Tag nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tag OUT, 'ticket_field.tag'
DECLARE @Title_in_portal nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title_in_portal OUT, 'ticket_field.title_in_portal'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'ticket_field.updated_at'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'ticket_field.url'
DECLARE @Visible_in_portal nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Visible_in_portal OUT, 'ticket_field.visible_in_portal'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'ticket_field.custom_field_options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'ticket_field.custom_field_options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'ticket_field.custom_field_options[i].value'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'ticket_field.custom_field_options[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'ticket_field.custom_field_options[i].position'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_name OUT, 'ticket_field.custom_field_options[i].raw_name'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'ticket_field.custom_field_options[i].url'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'ticket_field.custom_statuses'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'ticket_field.custom_statuses[i].active'
EXEC sp_OAMethod @jResp, 'StringOf', @agent_label OUT, 'ticket_field.custom_statuses[i].agent_label'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'ticket_field.custom_statuses[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @default OUT, 'ticket_field.custom_statuses[i].default'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'ticket_field.custom_statuses[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @end_user_description OUT, 'ticket_field.custom_statuses[i].end_user_description'
EXEC sp_OAMethod @jResp, 'StringOf', @end_user_label OUT, 'ticket_field.custom_statuses[i].end_user_label'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'ticket_field.custom_statuses[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @status_category OUT, 'ticket_field.custom_statuses[i].status_category'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'ticket_field.custom_statuses[i].updated_at'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'ticket_field.system_field_options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'ticket_field.system_field_options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'ticket_field.system_field_options[i].value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields
Postman Collection Item JSON
{
"name": "Create Ticket Field",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
]
},
"description": "Creates any of the following custom field types:\n\n| Custom field type | Description |\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| text | Default custom field type when `type` is not specified |\n| textarea | For multi-line text |\n| checkbox | To capture a boolean value. Allowed values are true or false |\n| date | Example: 2021-04-16 |\n| integer | String composed of numbers. May contain an optional decimal point |\n| decimal | For numbers containing decimals |\n| regexp | Matches the Regex pattern found in the custom field settings |\n| partialcreditcard | A credit card number. Only the last 4 digits are retained |\n| multiselect | Enables users to choose multiple options from a dropdown menu |\n| tagger | Single-select dropdown menu. It contains one or more tag values belonging to the field's options. Example: ( {\"id\": 21938362, \"value\": [\"hd_3000\", \"hd_5555\"]}) |\n| lookup | A field to create a relationship (see [lookup relationships](/api-reference/ticketing/lookup_relationships/lookup_relationships/)) to another object such as a user, ticket, or organization |\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in the Zendesk Help Center.\n\n#### Allowed For\n\n* Admins\n\n#### Field limits\n\nWe recommend the following best practices for ticket fields limits. Creating more than these amounts can affect performance.\n\n* 400 ticket fields per account if your account doesn't have ticket forms\n* 400 ticket fields per ticket form if your account has ticket forms\n"
},
"response": [
{
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_field\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_description\": \"<string>\",\n \"collapsed_for_agents\": \"<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 \"custom_statuses\": [\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"solved\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"open\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"description\": \"<string>\",\n \"editable_in_portal\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"raw_title_in_portal\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"removable\": \"<boolean>\",\n \"required\": \"<boolean>\",\n \"required_in_portal\": \"<boolean>\",\n \"sub_type_id\": \"<integer>\",\n \"system_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tag\": \"<string>\",\n \"title_in_portal\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"visible_in_portal\": \"<boolean>\"\n }\n}"
}
]
}
