PureBasic / Support API / Update User
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "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.
; {
; "user": {
; "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>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"user.name","<string>")
CkJsonObject::ckUpdateString(json,"user.email","<string>")
CkJsonObject::ckUpdateString(json,"user.custom_role_id","<integer>")
CkJsonObject::ckUpdateString(json,"user.external_id","<string>")
CkJsonObject::ckUpdateString(json,"user.identities[0].type","<string>")
CkJsonObject::ckUpdateString(json,"user.identities[0].value","<string>")
CkJsonObject::ckUpdateString(json,"user.identities[1].type","<string>")
CkJsonObject::ckUpdateString(json,"user.identities[1].value","<string>")
CkJsonObject::ckUpdateString(json,"user.organization.name","<string>")
CkJsonObject::ckUpdateString(json,"user.organization_id","<integer>")
CkJsonObject::ckUpdateString(json,"user.role","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://example.zendesk.com/api/v2/users/:user_id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "user": {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "dolorea1": false,
; "deserunt3": 95124319.10825741
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "nostrudacc": -12929960.546221554,
; "in_80e": 25167751.960886702,
; "proident_e2": true,
; "voluptate_98": -58995022
; },
; "verified": "<boolean>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Name.s = CkJsonObject::ckStringOf(jResp,"user.name")
Active.s = CkJsonObject::ckStringOf(jResp,"user.active")
Alias.s = CkJsonObject::ckStringOf(jResp,"user.alias")
Chat_only.s = CkJsonObject::ckStringOf(jResp,"user.chat_only")
Created_at.s = CkJsonObject::ckStringOf(jResp,"user.created_at")
Custom_role_id.s = CkJsonObject::ckStringOf(jResp,"user.custom_role_id")
Default_group_id.s = CkJsonObject::ckStringOf(jResp,"user.default_group_id")
Details.s = CkJsonObject::ckStringOf(jResp,"user.details")
v_Email.s = CkJsonObject::ckStringOf(jResp,"user.email")
External_id.s = CkJsonObject::ckStringOf(jResp,"user.external_id")
Iana_time_zone.s = CkJsonObject::ckStringOf(jResp,"user.iana_time_zone")
Id.s = CkJsonObject::ckStringOf(jResp,"user.id")
Last_login_at.s = CkJsonObject::ckStringOf(jResp,"user.last_login_at")
Locale.s = CkJsonObject::ckStringOf(jResp,"user.locale")
Locale_id.s = CkJsonObject::ckStringOf(jResp,"user.locale_id")
Moderator.s = CkJsonObject::ckStringOf(jResp,"user.moderator")
Notes.s = CkJsonObject::ckStringOf(jResp,"user.notes")
Only_private_comments.s = CkJsonObject::ckStringOf(jResp,"user.only_private_comments")
Organization_id.s = CkJsonObject::ckStringOf(jResp,"user.organization_id")
Phone.s = CkJsonObject::ckStringOf(jResp,"user.phone")
Dolorea1.i = CkJsonObject::ckBoolOf(jResp,"user.photo.dolorea1")
Deserunt3.s = CkJsonObject::ckStringOf(jResp,"user.photo.deserunt3")
Remote_photo_url.s = CkJsonObject::ckStringOf(jResp,"user.remote_photo_url")
Report_csv.s = CkJsonObject::ckStringOf(jResp,"user.report_csv")
Restricted_agent.s = CkJsonObject::ckStringOf(jResp,"user.restricted_agent")
Role.s = CkJsonObject::ckStringOf(jResp,"user.role")
Role_type.s = CkJsonObject::ckStringOf(jResp,"user.role_type")
v_Shared.s = CkJsonObject::ckStringOf(jResp,"user.shared")
Shared_agent.s = CkJsonObject::ckStringOf(jResp,"user.shared_agent")
Shared_phone_number.s = CkJsonObject::ckStringOf(jResp,"user.shared_phone_number")
Signature.s = CkJsonObject::ckStringOf(jResp,"user.signature")
Suspended.s = CkJsonObject::ckStringOf(jResp,"user.suspended")
Tags.s = CkJsonObject::ckStringOf(jResp,"user.tags")
Ticket_restriction.s = CkJsonObject::ckStringOf(jResp,"user.ticket_restriction")
Time_zone.s = CkJsonObject::ckStringOf(jResp,"user.time_zone")
Two_factor_auth_enabled.s = CkJsonObject::ckStringOf(jResp,"user.two_factor_auth_enabled")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"user.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"user.url")
Nostrudacc.s = CkJsonObject::ckStringOf(jResp,"user.user_fields.nostrudacc")
In_80e.s = CkJsonObject::ckStringOf(jResp,"user.user_fields.in_80e")
Proident_e2.i = CkJsonObject::ckBoolOf(jResp,"user.user_fields.proident_e2")
Voluptate_98.i = CkJsonObject::ckIntOf(jResp,"user.user_fields.voluptate_98")
Verified.s = CkJsonObject::ckStringOf(jResp,"user.verified")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"user": {
"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/:user_id
Postman Collection Item JSON
{
"name": "Update User",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user\": {\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
}
]
}
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"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 \"user\": {\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolorea1\": false,\n \"deserunt3\": 95124319.10825741\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nostrudacc\": -12929960.546221554,\n \"in_80e\": 25167751.960886702,\n \"proident_e2\": true,\n \"voluptate_98\": -58995022\n },\n \"verified\": \"<boolean>\"\n }\n}"
}
]
}
