Chilkat Online Tools

Powershell / Support API / Create Organization

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-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"

$http.SetRequestHeader("Accept","application/json")

$resp = $http.QuickRequest("POST","https://example.zendesk.com/api/v2/organizations")
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)

# {
#   "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

$Created_at = $jResp.StringOf("organization.created_at")
$Details = $jResp.StringOf("organization.details")
$External_id = $jResp.StringOf("organization.external_id")
$Group_id = $jResp.StringOf("organization.group_id")
$Id = $jResp.StringOf("organization.id")
$Name = $jResp.StringOf("organization.name")
$Notes = $jResp.StringOf("organization.notes")
$Fugiat5_0 = $jResp.StringOf("organization.organization_fields.fugiat5_0")
$Exercitation_039 = $jResp.StringOf("organization.organization_fields.exercitation_039")
$Laboris_60 = $jResp.StringOf("organization.organization_fields.laboris_60")
$Shared_comments = $jResp.StringOf("organization.shared_comments")
$Shared_tickets = $jResp.StringOf("organization.shared_tickets")
$Updated_at = $jResp.StringOf("organization.updated_at")
$v_Url = $jResp.StringOf("organization.url")
$i = 0
$count_i = $jResp.SizeOfArray("organization.domain_names")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("organization.domain_names[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("organization.tags")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("organization.tags[i]")
    $i = $i + 1
}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations

Postman Collection Item JSON

{
  "name": "Create Organization",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations"
      ]
    },
    "description": "You must provide a unique `name` for each organization. Normally\nthe system doesn't allow records to be created with identical names.\nHowever, a race condition can occur if you make two or more identical\nPOSTs very close to each other, causing the records to have identical\norganization names.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage organizations (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations"
          ]
        }
      },
      "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}"
    }
  ]
}