VB.NET / Support API / 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 = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/organizations/:organization_id")
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
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 = jResp.StringOf("organization.created_at")
Dim Details As String = jResp.StringOf("organization.details")
Dim External_id As String = jResp.StringOf("organization.external_id")
Dim Group_id As String = jResp.StringOf("organization.group_id")
Dim Id As String = jResp.StringOf("organization.id")
Dim Name As String = jResp.StringOf("organization.name")
Dim Notes As String = jResp.StringOf("organization.notes")
Dim Fugiat5_0 As String = jResp.StringOf("organization.organization_fields.fugiat5_0")
Dim Exercitation_039 As String = jResp.StringOf("organization.organization_fields.exercitation_039")
Dim Laboris_60 As String = jResp.StringOf("organization.organization_fields.laboris_60")
Dim Shared_comments As String = jResp.StringOf("organization.shared_comments")
Dim Shared_tickets As String = jResp.StringOf("organization.shared_tickets")
Dim Updated_at As String = jResp.StringOf("organization.updated_at")
Dim v_Url As String = jResp.StringOf("organization.url")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("organization.domain_names")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("organization.domain_names[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("organization.tags")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("organization.tags[i]")
i = i + 1
End While
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/:organization_id
Postman Collection Item JSON
{
"name": "Update Organization",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* Admins\n* Agents\n\nAgents with no permissions restrictions can only update \"notes\" on organizations.\n\n**Note** Updating an organization overwrites all existing `domain_names` values. To prevent this, submit a complete list of `domain_names` associated with the organization in your request.\n\n#### Example Request\n\n```js\n{\n \"organization\": {\n \"notes\": \"Something interesting\"\n }\n}\n```\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id"
}
]
}
},
"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": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
":organization_id"
],
"variable": [
{
"key": "organization_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
