Chilkat Online Tools

Java / Support API / Create Or Update Many Users

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");

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "users": [
    //     {
    //       "name": "<string>",
    //       "email": "<string>",
    //       "custom_role_id": "<integer>",
    //       "external_id": "<string>",
    //       "identities": [
    //         {
    //           "type": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "type": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "organization": {
    //         "name": "<string>"
    //       },
    //       "organization_id": "<integer>",
    //       "role": "<string>"
    //     },
    //     {
    //       "name": "<string>",
    //       "email": "<string>",
    //       "custom_role_id": "<integer>",
    //       "external_id": "<string>",
    //       "identities": [
    //         {
    //           "type": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "type": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "organization": {
    //         "name": "<string>"
    //       },
    //       "organization_id": "<integer>",
    //       "role": "<string>"
    //     }
    //   ]
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("users[0].name","<string>");
    json.UpdateString("users[0].email","<string>");
    json.UpdateString("users[0].custom_role_id","<integer>");
    json.UpdateString("users[0].external_id","<string>");
    json.UpdateString("users[0].identities[0].type","<string>");
    json.UpdateString("users[0].identities[0].value","<string>");
    json.UpdateString("users[0].identities[1].type","<string>");
    json.UpdateString("users[0].identities[1].value","<string>");
    json.UpdateString("users[0].organization.name","<string>");
    json.UpdateString("users[0].organization_id","<integer>");
    json.UpdateString("users[0].role","<string>");
    json.UpdateString("users[1].name","<string>");
    json.UpdateString("users[1].email","<string>");
    json.UpdateString("users[1].custom_role_id","<integer>");
    json.UpdateString("users[1].external_id","<string>");
    json.UpdateString("users[1].identities[0].type","<string>");
    json.UpdateString("users[1].identities[0].value","<string>");
    json.UpdateString("users[1].identities[1].type","<string>");
    json.UpdateString("users[1].identities[1].value","<string>");
    json.UpdateString("users[1].organization.name","<string>");
    json.UpdateString("users[1].organization_id","<integer>");
    json.UpdateString("users[1].role","<string>");

    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.PostJson3("https://example.zendesk.com/api/v2/users/create_or_update_many","application/json",json);
    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 POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "users": [
    {
      "name": "<string>",
      "email": "<string>",
      "custom_role_id": "<integer>",
      "external_id": "<string>",
      "identities": [
        {
          "type": "<string>",
          "value": "<string>"
        },
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "organization": {
        "name": "<string>"
      },
      "organization_id": "<integer>",
      "role": "<string>"
    },
    {
      "name": "<string>",
      "email": "<string>",
      "custom_role_id": "<integer>",
      "external_id": "<string>",
      "identities": [
        {
          "type": "<string>",
          "value": "<string>"
        },
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "organization": {
        "name": "<string>"
      },
      "organization_id": "<integer>",
      "role": "<string>"
    }
  ]
}'
https://example.zendesk.com/api/v2/users/create_or_update_many

Postman Collection Item JSON

{
  "name": "Create Or Update Many Users",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"users\": [\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"external_id\": \"<string>\",\n      \"identities\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"organization\": {\n        \"name\": \"<string>\"\n      },\n      \"organization_id\": \"<integer>\",\n      \"role\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"external_id\": \"<string>\",\n      \"identities\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"organization\": {\n        \"name\": \"<string>\"\n      },\n      \"organization_id\": \"<integer>\",\n      \"role\": \"<string>\"\n    }\n  ]\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/create_or_update_many",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        "create_or_update_many"
      ]
    },
    "description": "Accepts an array of up to 100 user objects. For each user, the user is created if it does not\nalready exist, or the existing user is updated.\n\n**Note**: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact [Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/4408843597850) to enable the imports. A 403 Forbidden\nerror is returned if data imports are not enabled.    \n\nEach individual user object can identify an existing user by `email` or by `external_id`.\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* Agents, with restrictions on certain actions\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"users\": [\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"external_id\": \"<string>\",\n      \"identities\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"organization\": {\n        \"name\": \"<string>\"\n      },\n      \"organization_id\": \"<integer>\",\n      \"role\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"external_id\": \"<string>\",\n      \"identities\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"type\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"organization\": {\n        \"name\": \"<string>\"\n      },\n      \"organization_id\": \"<integer>\",\n      \"role\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/create_or_update_many",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            "create_or_update_many"
          ]
        }
      },
      "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}"
    }
  ]
}