Foxpro / Support API / Create Many Users
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcIndex
LOCAL lcId
LOCAL lcMessage
LOCAL lcProgress
LOCAL lcStatus
LOCAL lcTotal
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.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>"
* }
* ]
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("users[0].name","<string>")
loJson.UpdateString("users[0].email","<string>")
loJson.UpdateString("users[0].custom_role_id","<integer>")
loJson.UpdateString("users[0].external_id","<string>")
loJson.UpdateString("users[0].identities[0].type","<string>")
loJson.UpdateString("users[0].identities[0].value","<string>")
loJson.UpdateString("users[0].identities[1].type","<string>")
loJson.UpdateString("users[0].identities[1].value","<string>")
loJson.UpdateString("users[0].organization.name","<string>")
loJson.UpdateString("users[0].organization_id","<integer>")
loJson.UpdateString("users[0].role","<string>")
loJson.UpdateString("users[1].name","<string>")
loJson.UpdateString("users[1].email","<string>")
loJson.UpdateString("users[1].custom_role_id","<integer>")
loJson.UpdateString("users[1].external_id","<string>")
loJson.UpdateString("users[1].identities[0].type","<string>")
loJson.UpdateString("users[1].identities[0].value","<string>")
loJson.UpdateString("users[1].identities[1].type","<string>")
loJson.UpdateString("users[1].identities[1].value","<string>")
loJson.UpdateString("users[1].organization.name","<string>")
loJson.UpdateString("users[1].organization_id","<integer>")
loJson.UpdateString("users[1].role","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://example.zendesk.com/api/v2/users/create_many","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("job_status.id")
lcMessage = loJResp.StringOf("job_status.message")
lcProgress = loJResp.StringOf("job_status.progress")
lcStatus = loJResp.StringOf("job_status.status")
lcTotal = loJResp.StringOf("job_status.total")
lcV_Url = loJResp.StringOf("job_status.url")
i = 0
lnCount_i = loJResp.SizeOfArray("job_status.results")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("job_status.results[i].id")
lcIndex = loJResp.StringOf("job_status.results[i].index")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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_many
Postman Collection Item JSON
{
"name": "Create 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_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_many"
]
},
"description": "Accepts an array of up to 100 user objects.\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\n#### Allowed For\n\n* Agents, with restrictions on certain actions\n\n#### Specifying an organization\n\nYou can assign a user to an existing organization by setting an\n`organization_id` property in the user object.\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"
},
"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_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_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}"
}
]
}
