Chilkat Online Tools

autoit / Support API / Create Membership

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/organization_memberships")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "organization_membership": {
;     "user_id": "<integer>",
;     "organization_id": "<integer>",
;     "default": "<boolean>",
;     "created_at": "<dateTime>",
;     "id": "<integer>",
;     "organization_name": "<string>",
;     "updated_at": "<dateTime>",
;     "url": "<string>",
;     "view_tickets": "<boolean>"
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sUser_id = $oJResp.StringOf("organization_membership.user_id")
Local $sOrganization_id = $oJResp.StringOf("organization_membership.organization_id")
Local $sDefault = $oJResp.StringOf("organization_membership.default")
Local $sCreated_at = $oJResp.StringOf("organization_membership.created_at")
Local $sId = $oJResp.StringOf("organization_membership.id")
Local $sOrganization_name = $oJResp.StringOf("organization_membership.organization_name")
Local $sUpdated_at = $oJResp.StringOf("organization_membership.updated_at")
Local $sV_Url = $oJResp.StringOf("organization_membership.url")
Local $sView_tickets = $oJResp.StringOf("organization_membership.view_tickets")

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_memberships

Postman Collection Item JSON

{
  "name": "Create Membership",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_memberships",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_memberships"
      ]
    },
    "description": "Assigns a user to a given organization. Returns an error with status 422 if the user is already assigned to the organization.\n\n#### Allowed For\n\n* Admins\n* Agents when creating a new organization membership for an end user\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organization_memberships",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_memberships"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_membership\": {\n    \"user_id\": \"<integer>\",\n    \"organization_id\": \"<integer>\",\n    \"default\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"organization_name\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"view_tickets\": \"<boolean>\"\n  }\n}"
    }
  ]
}