PureBasic Zendesk: Create a User

Back to Index

Creates a new user.

Documentation: https://developer.zendesk.com/rest_api/docs/core/users#create-user

CURL Command

curl https://subdomain.zendesk.com/api/v2/users.json \
  -d '{"user": {"name": "Roger Wilco", "email": "roger@chilkat.io"}}' \
  -H "Content-Type: application/json" -X POST \
  -u zendesk_email/token:zendesk_api_token

PureBasic Example

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ;  URL: https://subdomain.zendesk.com/api/v2/users.json
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"subdomain.zendesk.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckSetAuthBasic(rest,"zendesk_email/token","zendesk_api_token")

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"user.name","Roger Wilco")
    CkJsonObject::ckUpdateString(json,"user.email","roger@chilkat.io")

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/api/v2/users.json",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    If respStatusCode >= 400
        Debug "Response Status Code = " + Str(respStatusCode)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    userId.i
    userUrl.s
    userName.s
    userEmail.s
    userCreated_at.s
    userUpdated_at.s
    userTime_zone.s
    userPhone.s
    userShared_phone_number.s
    userPhoto.s
    userLocale_id.i
    userLocale.s
    userOrganization_id.s
    userRole.s
    userVerified.i
    userExternal_id.s
    userAlias.s
    userActive.i
    userShared.i
    userShared_agent.i
    userLast_login_at.s
    userTwo_factor_auth_enabled.i
    userSignature.s
    userDetails.s
    userNotes.s
    userRole_type.s
    userCustom_role_id.s
    userModerator.i
    userTicket_restriction.s
    userOnly_private_comments.i
    userRestricted_agent.i
    userSuspended.i
    userChat_only.i
    userDefault_group_id.s
    i.i
    count_i.i

    userId = CkJsonObject::ckIntOf(jsonResponse,"user.id")
    userUrl = CkJsonObject::ckStringOf(jsonResponse,"user.url")
    userName = CkJsonObject::ckStringOf(jsonResponse,"user.name")
    userEmail = CkJsonObject::ckStringOf(jsonResponse,"user.email")
    userCreated_at = CkJsonObject::ckStringOf(jsonResponse,"user.created_at")
    userUpdated_at = CkJsonObject::ckStringOf(jsonResponse,"user.updated_at")
    userTime_zone = CkJsonObject::ckStringOf(jsonResponse,"user.time_zone")
    userPhone = CkJsonObject::ckStringOf(jsonResponse,"user.phone")
    userShared_phone_number = CkJsonObject::ckStringOf(jsonResponse,"user.shared_phone_number")
    userPhoto = CkJsonObject::ckStringOf(jsonResponse,"user.photo")
    userLocale_id = CkJsonObject::ckIntOf(jsonResponse,"user.locale_id")
    userLocale = CkJsonObject::ckStringOf(jsonResponse,"user.locale")
    userOrganization_id = CkJsonObject::ckStringOf(jsonResponse,"user.organization_id")
    userRole = CkJsonObject::ckStringOf(jsonResponse,"user.role")
    userVerified = CkJsonObject::ckBoolOf(jsonResponse,"user.verified")
    userExternal_id = CkJsonObject::ckStringOf(jsonResponse,"user.external_id")
    userAlias = CkJsonObject::ckStringOf(jsonResponse,"user.alias")
    userActive = CkJsonObject::ckBoolOf(jsonResponse,"user.active")
    userShared = CkJsonObject::ckBoolOf(jsonResponse,"user.shared")
    userShared_agent = CkJsonObject::ckBoolOf(jsonResponse,"user.shared_agent")
    userLast_login_at = CkJsonObject::ckStringOf(jsonResponse,"user.last_login_at")
    userTwo_factor_auth_enabled = CkJsonObject::ckBoolOf(jsonResponse,"user.two_factor_auth_enabled")
    userSignature = CkJsonObject::ckStringOf(jsonResponse,"user.signature")
    userDetails = CkJsonObject::ckStringOf(jsonResponse,"user.details")
    userNotes = CkJsonObject::ckStringOf(jsonResponse,"user.notes")
    userRole_type = CkJsonObject::ckStringOf(jsonResponse,"user.role_type")
    userCustom_role_id = CkJsonObject::ckStringOf(jsonResponse,"user.custom_role_id")
    userModerator = CkJsonObject::ckBoolOf(jsonResponse,"user.moderator")
    userTicket_restriction = CkJsonObject::ckStringOf(jsonResponse,"user.ticket_restriction")
    userOnly_private_comments = CkJsonObject::ckBoolOf(jsonResponse,"user.only_private_comments")
    userRestricted_agent = CkJsonObject::ckBoolOf(jsonResponse,"user.restricted_agent")
    userSuspended = CkJsonObject::ckBoolOf(jsonResponse,"user.suspended")
    userChat_only = CkJsonObject::ckBoolOf(jsonResponse,"user.chat_only")
    userDefault_group_id = CkJsonObject::ckStringOf(jsonResponse,"user.default_group_id")
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"user.tags")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure

Sample JSON Response Body

{
  "user": {
    "id": 361811376954,
    "url": "https://chilkat.zendesk.com/api/v2/users/361811376954.json",
    "name": "Roger Wilco",
    "email": "roger@chilkat.io",
    "created_at": "2018-04-14T23:09:24Z",
    "updated_at": "2018-04-14T23:09:24Z",
    "time_zone": "Bogota",
    "phone": null,
    "shared_phone_number": null,
    "photo": null,
    "locale_id": 1,
    "locale": "en-US",
    "organization_id": null,
    "role": "end-user",
    "verified": false,
    "external_id": null,
    "tags": [
    ],
    "alias": null,
    "active": true,
    "shared": false,
    "shared_agent": false,
    "last_login_at": null,
    "two_factor_auth_enabled": false,
    "signature": null,
    "details": null,
    "notes": null,
    "role_type": null,
    "custom_role_id": null,
    "moderator": false,
    "ticket_restriction": "requested",
    "only_private_comments": false,
    "restricted_agent": true,
    "suspended": false,
    "chat_only": false,
    "default_group_id": null,
    "user_fields": {}
  }
}