Java / Support API / Update Many Organizations
Back to Collection Items
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/organizations/update_many?ids=<string>&external_ids=<string>");
if (http.get_LastMethodSuccess() == false) {
System.out.println(http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
System.out.println("Response Body:");
System.out.println(jResp.emit());
int respStatusCode = resp.get_StatusCode();
System.out.println("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
System.out.println("Response Header:");
System.out.println(resp.header());
System.out.println("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "job_status": {
// "id": "<string>",
// "message": "<string>",
// "progress": "<integer>",
// "results": [
// {
// "id": "<integer>",
// "index": "<integer>"
// },
// {
// "id": "<integer>",
// "index": "<integer>"
// }
// ],
// "status": "<string>",
// "total": "<integer>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
String id;
String index;
String Id = jResp.stringOf("job_status.id");
String Message = jResp.stringOf("job_status.message");
String Progress = jResp.stringOf("job_status.progress");
String Status = jResp.stringOf("job_status.status");
String Total = jResp.stringOf("job_status.total");
String v_Url = jResp.stringOf("job_status.url");
int i = 0;
int count_i = jResp.SizeOfArray("job_status.results");
while (i < count_i) {
jResp.put_I(i);
id = jResp.stringOf("job_status.results[i].id");
index = jResp.stringOf("job_status.results[i].index");
i = i+1;
}
}
}
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/update_many?ids=<string>&external_ids=<string>
Postman Collection Item JSON
{
"name": "Update Many Organizations",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/update_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"update_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "A list of organization ids"
},
{
"key": "external_ids",
"value": "<string>",
"description": "A list of external ids"
}
]
},
"description": "Bulk or batch updates up to 100 organizations.\n\n#### Bulk update\n\nTo make the same change to multiple organizations, use the following endpoint and data format:\n\n`https://{subdomain}.zendesk.com/api/v2/organizations/update_many.json?ids=1,2,3`\n\n```js\n{\n \"organization\": {\n \"notes\": \"Priority\"\n }\n}\n```\n\n#### Batch update\n\nTo make different changes to multiple organizations, use the following endpoint and data format:\n\n`https://{subdomain}.zendesk.com/api/v2/organizations/update_many.json`\n\n```js\n{\n \"organizations\": [\n { \"id\": 1, \"notes\": \"Priority\" },\n { \"id\": 2, \"notes\": \"Normal\" }\n ]\n}\n```\n\n#### Response\n\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.\nUse the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.\n\n#### Allowed For\n\n* Admins\n* Agents\n\nAgents with no permissions restrictions can only update \"notes\" on organizations.\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/update_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"update_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "A list of organization ids"
},
{
"key": "external_ids",
"value": "<string>",
"description": "A list of external ids"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"job_status\": {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}