Xojo / Support API / Create Or Update Organization
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"
http.SetRequestHeader "Accept","application/json"
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/organizations/create_or_update")
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)
// {
// "organization": {
// "created_at": "<string>",
// "details": "<string>",
// "domain_names": [
// "<string>",
// "<string>"
// ],
// "external_id": "<string>",
// "group_id": "<integer>",
// "id": "<integer>",
// "name": "<string>",
// "notes": "<string>",
// "organization_fields": {
// "fugiat5_0": "<string>",
// "exercitation_039": "<string>",
// "laboris_60": "<string>"
// },
// "shared_comments": "<boolean>",
// "shared_tickets": "<boolean>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "updated_at": "<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 strVal As String
Dim Created_at As String
Created_at = jResp.StringOf("organization.created_at")
Dim Details As String
Details = jResp.StringOf("organization.details")
Dim External_id As String
External_id = jResp.StringOf("organization.external_id")
Dim Group_id As String
Group_id = jResp.StringOf("organization.group_id")
Dim Id As String
Id = jResp.StringOf("organization.id")
Dim Name As String
Name = jResp.StringOf("organization.name")
Dim Notes As String
Notes = jResp.StringOf("organization.notes")
Dim Fugiat5_0 As String
Fugiat5_0 = jResp.StringOf("organization.organization_fields.fugiat5_0")
Dim Exercitation_039 As String
Exercitation_039 = jResp.StringOf("organization.organization_fields.exercitation_039")
Dim Laboris_60 As String
Laboris_60 = jResp.StringOf("organization.organization_fields.laboris_60")
Dim Shared_comments As String
Shared_comments = jResp.StringOf("organization.shared_comments")
Dim Shared_tickets As String
Shared_tickets = jResp.StringOf("organization.shared_tickets")
Dim Updated_at As String
Updated_at = jResp.StringOf("organization.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("organization.url")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("organization.domain_names")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("organization.domain_names[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("organization.tags")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("organization.tags[i]")
i = i + 1
Wend
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/create_or_update
Postman Collection Item JSON
{
"name": "Create Or Update Organization",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
},
"description": "Creates an organization if it doesn't already exist, or updates\nan existing organization. Using this method means one less call\nto check if an organization exists before creating it. You need\nto specify the id or external id when updating\nan organization to avoid a duplicate error response. Name is\nnot available as a matching criteria.\n\n#### Allowed For\n\n* Agents, with restrictions on certain actions\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/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"organization\": {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"fugiat5_0\": \"<string>\",\n \"exercitation_039\": \"<string>\",\n \"laboris_60\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<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/organizations/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"create_or_update"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"organization\": {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"fugiat5_0\": \"<string>\",\n \"exercitation_039\": \"<string>\",\n \"laboris_60\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
