autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/organizations/create_or_update")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $strVal
Local $sCreated_at = $oJResp.StringOf("organization.created_at")
Local $sDetails = $oJResp.StringOf("organization.details")
Local $sExternal_id = $oJResp.StringOf("organization.external_id")
Local $sGroup_id = $oJResp.StringOf("organization.group_id")
Local $sId = $oJResp.StringOf("organization.id")
Local $sName = $oJResp.StringOf("organization.name")
Local $sNotes = $oJResp.StringOf("organization.notes")
Local $sFugiat5_0 = $oJResp.StringOf("organization.organization_fields.fugiat5_0")
Local $sExercitation_039 = $oJResp.StringOf("organization.organization_fields.exercitation_039")
Local $sLaboris_60 = $oJResp.StringOf("organization.organization_fields.laboris_60")
Local $sShared_comments = $oJResp.StringOf("organization.shared_comments")
Local $sShared_tickets = $oJResp.StringOf("organization.shared_tickets")
Local $sUpdated_at = $oJResp.StringOf("organization.updated_at")
Local $sV_Url = $oJResp.StringOf("organization.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("organization.domain_names")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("organization.domain_names[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("organization.tags")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.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}"
}
]
}
