Chilkat Online Tools

VB.NET / Support API / Create Organization Subscription

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.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.

' {
'   "organization_subscription": {
'     "organization_id": "<integer>",
'     "user_id": "<integer>"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("organization_subscription.organization_id","<integer>")
json.UpdateString("organization_subscription.user_id","<integer>")

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

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://example.zendesk.com/api/v2/organization_subscriptions","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



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

' {
'   "organization_subscription": {
'     "created_at": "<dateTime>",
'     "id": "<integer>",
'     "organization_id": "<integer>",
'     "user_id": "<integer>"
'   }
' }

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




Dim Created_at As String = jResp.StringOf("organization_subscription.created_at")
Dim Id As String = jResp.StringOf("organization_subscription.id")
Dim Organization_id As String = jResp.StringOf("organization_subscription.organization_id")
Dim User_id As String = jResp.StringOf("organization_subscription.user_id")

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "organization_subscription": {
    "organization_id": "<integer>",
    "user_id": "<integer>"
  }
}'
https://example.zendesk.com/api/v2/organization_subscriptions

Postman Collection Item JSON

{
  "name": "Create Organization Subscription",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"organization_subscription\": {\n    \"organization_id\": \"<integer>\",\n    \"user_id\": \"<integer>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_subscriptions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_subscriptions"
      ]
    },
    "description": "#### Allowed For:\n\n* Agents\n* End users\n\nEnd users can only subscribe to shared organizations in which they're members."
  },
  "response": [
    {
      "name": "Successful 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  \"organization_subscription\": {\n    \"organization_id\": \"<integer>\",\n    \"user_id\": \"<integer>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/organization_subscriptions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_subscriptions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_subscription\": {\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"organization_id\": \"<integer>\",\n    \"user_id\": \"<integer>\"\n  }\n}"
    }
  ]
}