Xojo / Support API / Create Custom Object Record
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
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>"
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("custom_object_record.name","<string>")
success = json.UpdateString("custom_object_record.created_at","<dateTime>")
success = json.UpdateString("custom_object_record.created_by_user_id","<string>")
success = json.UpdateString("custom_object_record.custom_object_fields.do8","<string>")
success = json.UpdateString("custom_object_record.custom_object_fields.adipisicing_e","<string>")
success = json.UpdateString("custom_object_record.custom_object_fields.commodo0","<string>")
success = json.UpdateString("custom_object_record.custom_object_fields.sunta4","<string>")
success = json.UpdateString("custom_object_record.custom_object_key","<string>")
success = json.UpdateString("custom_object_record.external_id","<string>")
success = json.UpdateString("custom_object_record.id","<string>")
success = json.UpdateString("custom_object_record.updated_at","<dateTime>")
success = json.UpdateString("custom_object_record.updated_by_user_id","<string>")
success = json.UpdateString("custom_object_record.url","<string>")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records","application/json",json)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim Name As String
Name = jResp.StringOf("custom_object_record.name")
Dim Created_at As String
Created_at = jResp.StringOf("custom_object_record.created_at")
Dim Created_by_user_id As String
Created_by_user_id = jResp.StringOf("custom_object_record.created_by_user_id")
Dim Do8 As String
Do8 = jResp.StringOf("custom_object_record.custom_object_fields.do8")
Dim Adipisicing_e As String
Adipisicing_e = jResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
Dim Commodo0 As String
Commodo0 = jResp.StringOf("custom_object_record.custom_object_fields.commodo0")
Dim Sunta4 As String
Sunta4 = jResp.StringOf("custom_object_record.custom_object_fields.sunta4")
Dim Custom_object_key As String
Custom_object_key = jResp.StringOf("custom_object_record.custom_object_key")
Dim External_id As String
External_id = jResp.StringOf("custom_object_record.external_id")
Dim Id As String
Id = jResp.StringOf("custom_object_record.id")
Dim Updated_at As String
Updated_at = jResp.StringOf("custom_object_record.updated_at")
Dim Updated_by_user_id As String
Updated_by_user_id = jResp.StringOf("custom_object_record.updated_by_user_id")
Dim v_Url As String
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}"
}
]
}
