Chilkat Online Tools

Objective-C / Support API / Create Membership

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequest: @"POST" url: @"https://example.zendesk.com/api/v2/organization_memberships"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *User_id = [jResp StringOf: @"organization_membership.user_id"];
NSString *Organization_id = [jResp StringOf: @"organization_membership.organization_id"];
NSString *Default = [jResp StringOf: @"organization_membership.default"];
NSString *Created_at = [jResp StringOf: @"organization_membership.created_at"];
NSString *Id = [jResp StringOf: @"organization_membership.id"];
NSString *Organization_name = [jResp StringOf: @"organization_membership.organization_name"];
NSString *Updated_at = [jResp StringOf: @"organization_membership.updated_at"];
NSString *v_Url = [jResp StringOf: @"organization_membership.url"];
NSString *View_tickets = [jResp 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}"
    }
  ]
}