Node.js / Support API / Update Organization
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "login";
http.Password = "password";
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/organizations/:organization_id");
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var strVal;
var Created_at = jResp.StringOf("organization.created_at");
var Details = jResp.StringOf("organization.details");
var External_id = jResp.StringOf("organization.external_id");
var Group_id = jResp.StringOf("organization.group_id");
var Id = jResp.StringOf("organization.id");
var Name = jResp.StringOf("organization.name");
var Notes = jResp.StringOf("organization.notes");
var Fugiat5_0 = jResp.StringOf("organization.organization_fields.fugiat5_0");
var Exercitation_039 = jResp.StringOf("organization.organization_fields.exercitation_039");
var Laboris_60 = jResp.StringOf("organization.organization_fields.laboris_60");
var Shared_comments = jResp.StringOf("organization.shared_comments");
var Shared_tickets = jResp.StringOf("organization.shared_tickets");
var Updated_at = jResp.StringOf("organization.updated_at");
var v_Url = jResp.StringOf("organization.url");
var i = 0;
var count_i = jResp.SizeOfArray("organization.domain_names");
while (i < 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 < count_i) {
jResp.I = i;
strVal = jResp.StringOf("organization.tags[i]");
i = i+1;
}
}
chilkatExample();
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}"
}
]
}
