Powershell / Support API / Create Custom Object Record
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"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "custom_object_record": {
# "name": "<string>",
# "created_at": "<dateTime>",
# "created_by_user_id": "<string>",
# "custom_object_fields": {
# "do8": "<string>",
# "adipisicing_e": "<string>",
# "commodo0": "<string>",
# "sunta4": "<string>"
# },
# "custom_object_key": "<string>",
# "external_id": "<string>",
# "id": "<string>",
# "updated_at": "<dateTime>",
# "updated_by_user_id": "<string>",
# "url": "<string>"
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("custom_object_record.name","<string>")
$json.UpdateString("custom_object_record.created_at","<dateTime>")
$json.UpdateString("custom_object_record.created_by_user_id","<string>")
$json.UpdateString("custom_object_record.custom_object_fields.do8","<string>")
$json.UpdateString("custom_object_record.custom_object_fields.adipisicing_e","<string>")
$json.UpdateString("custom_object_record.custom_object_fields.commodo0","<string>")
$json.UpdateString("custom_object_record.custom_object_fields.sunta4","<string>")
$json.UpdateString("custom_object_record.custom_object_key","<string>")
$json.UpdateString("custom_object_record.external_id","<string>")
$json.UpdateString("custom_object_record.id","<string>")
$json.UpdateString("custom_object_record.updated_at","<dateTime>")
$json.UpdateString("custom_object_record.updated_by_user_id","<string>")
$json.UpdateString("custom_object_record.url","<string>")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records","application/json",$json)
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_object_record": {
# "name": "<string>",
# "created_at": "<dateTime>",
# "created_by_user_id": "<string>",
# "custom_object_fields": {
# "do8": "<string>",
# "adipisicing_e": "<string>",
# "commodo0": "<string>",
# "sunta4": "<string>"
# },
# "custom_object_key": "<string>",
# "external_id": "<string>",
# "id": "<string>",
# "updated_at": "<dateTime>",
# "updated_by_user_id": "<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_object_record.name")
$Created_at = $jResp.StringOf("custom_object_record.created_at")
$Created_by_user_id = $jResp.StringOf("custom_object_record.created_by_user_id")
$Do8 = $jResp.StringOf("custom_object_record.custom_object_fields.do8")
$Adipisicing_e = $jResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
$Commodo0 = $jResp.StringOf("custom_object_record.custom_object_fields.commodo0")
$Sunta4 = $jResp.StringOf("custom_object_record.custom_object_fields.sunta4")
$Custom_object_key = $jResp.StringOf("custom_object_record.custom_object_key")
$External_id = $jResp.StringOf("custom_object_record.external_id")
$Id = $jResp.StringOf("custom_object_record.id")
$Updated_at = $jResp.StringOf("custom_object_record.updated_at")
$Updated_by_user_id = $jResp.StringOf("custom_object_record.updated_by_user_id")
$v_Url = $jResp.StringOf("custom_object_record.url")
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"custom_object_record": {
"name": "<string>",
"created_at": "<dateTime>",
"created_by_user_id": "<string>",
"custom_object_fields": {
"do8": "<string>",
"adipisicing_e": "<string>",
"commodo0": "<string>",
"sunta4": "<string>"
},
"custom_object_key": "<string>",
"external_id": "<string>",
"id": "<string>",
"updated_at": "<dateTime>",
"updated_by_user_id": "<string>",
"url": "<string>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records
Postman Collection Item JSON
{
"name": "Create Custom Object Record",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Creates a custom object record according to all the properties described by a custom object definition\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
