SQL Server / Support API / Update Organization 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, 'PUT', 'https://example.zendesk.com/api/v2/organization_fields/:organization_field_id'
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)
-- {
-- "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
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 @Key nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Key OUT, 'organization_field.key'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'organization_field.type'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'organization_field.title'
DECLARE @Active nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'organization_field.active'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'organization_field.created_at'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'organization_field.description'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'organization_field.id'
DECLARE @Position nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Position OUT, 'organization_field.position'
DECLARE @Raw_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_description OUT, 'organization_field.raw_description'
DECLARE @Raw_title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_title OUT, 'organization_field.raw_title'
DECLARE @Regexp_for_validation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Regexp_for_validation OUT, 'organization_field.regexp_for_validation'
DECLARE @Relationship_target_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Relationship_target_type OUT, 'organization_field.relationship_target_type'
DECLARE @System nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @System OUT, 'organization_field.system'
DECLARE @Tag nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tag OUT, 'organization_field.tag'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'organization_field.updated_at'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'organization_field.url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'organization_field.custom_field_options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'organization_field.custom_field_options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'organization_field.custom_field_options[i].value'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'organization_field.custom_field_options[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'organization_field.custom_field_options[i].position'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_name OUT, 'organization_field.custom_field_options[i].raw_name'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'organization_field.custom_field_options[i].url'
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 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}"
}
]
}
