Chilkat Online Tools

delphiAx / Support API / Create Organization Subscription

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Created_at: WideString;
Id: WideString;
Organization_id: WideString;
User_id: WideString;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
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>"
//   }
// }

json := TChilkatJsonObject.Create(Self);
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');

resp := http.PostJson3('https://example.zendesk.com/api/v2/organization_subscriptions','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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

Created_at := jResp.StringOf('organization_subscription.created_at');
Id := jResp.StringOf('organization_subscription.id');
Organization_id := jResp.StringOf('organization_subscription.organization_id');
User_id := 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}"
    }
  ]
}