Chilkat Online Tools

delphiAx / Support API / Create Custom Role

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Name: WideString;
Role_type: WideString;
Assign_tickets_to_any_group: WideString;
Chat_access: WideString;
End_user_list_access: WideString;
End_user_profile_access: WideString;
Explore_access: WideString;
Forum_access: WideString;
Forum_access_restricted_content: WideString;
Group_access: WideString;
Light_agent: WideString;
Macro_access: WideString;
Manage_business_rules: WideString;
Manage_contextual_workspaces: WideString;
Manage_dynamic_content: WideString;
Manage_extensions_and_channels: WideString;
Manage_facebook: WideString;
Manage_organization_fields: WideString;
Manage_ticket_fields: WideString;
Manage_ticket_forms: WideString;
Manage_user_fields: WideString;
Moderate_forums: WideString;
Organization_editing: WideString;
Organization_notes_editing: WideString;
Report_access: WideString;
Side_conversation_create: WideString;
Ticket_access: WideString;
Ticket_comment_access: WideString;
Ticket_deletion: WideString;
Ticket_editing: WideString;
Ticket_merge: WideString;
Ticket_tag_editing: WideString;
Twitter_search_access: WideString;
User_view_access: WideString;
View_access: WideString;
View_deleted_tickets: WideString;
Voice_access: WideString;
Voice_dashboard_access: WideString;
Created_at: WideString;
Description: WideString;
Id: WideString;
Team_member_count: WideString;
Updated_at: 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';

http.SetRequestHeader('Accept','application/json');

resp := http.QuickRequest('POST','https://example.zendesk.com/api/v2/custom_roles');
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)

// {
//   "custom_role": {
//     "name": "<string>",
//     "role_type": "<integer>",
//     "configuration": {
//       "assign_tickets_to_any_group": "<boolean>",
//       "chat_access": "<boolean>",
//       "end_user_list_access": "<string>",
//       "end_user_profile_access": "<string>",
//       "explore_access": "<string>",
//       "forum_access": "<string>",
//       "forum_access_restricted_content": "<boolean>",
//       "group_access": "<boolean>",
//       "light_agent": "<boolean>",
//       "macro_access": "<string>",
//       "manage_business_rules": "<boolean>",
//       "manage_contextual_workspaces": "<boolean>",
//       "manage_dynamic_content": "<boolean>",
//       "manage_extensions_and_channels": "<boolean>",
//       "manage_facebook": "<boolean>",
//       "manage_organization_fields": "<boolean>",
//       "manage_ticket_fields": "<boolean>",
//       "manage_ticket_forms": "<boolean>",
//       "manage_user_fields": "<boolean>",
//       "moderate_forums": "<boolean>",
//       "organization_editing": "<boolean>",
//       "organization_notes_editing": "<boolean>",
//       "report_access": "<string>",
//       "side_conversation_create": "<boolean>",
//       "ticket_access": "<string>",
//       "ticket_comment_access": "<string>",
//       "ticket_deletion": "<boolean>",
//       "ticket_editing": "<boolean>",
//       "ticket_merge": "<boolean>",
//       "ticket_tag_editing": "<boolean>",
//       "twitter_search_access": "<boolean>",
//       "user_view_access": "<string>",
//       "view_access": "<string>",
//       "view_deleted_tickets": "<boolean>",
//       "voice_access": "<boolean>",
//       "voice_dashboard_access": "<boolean>"
//     },
//     "created_at": "<dateTime>",
//     "description": "<string>",
//     "id": "<integer>",
//     "team_member_count": "<integer>",
//     "updated_at": "<dateTime>"
//   }
// }

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

Name := jResp.StringOf('custom_role.name');
Role_type := jResp.StringOf('custom_role.role_type');
Assign_tickets_to_any_group := jResp.StringOf('custom_role.configuration.assign_tickets_to_any_group');
Chat_access := jResp.StringOf('custom_role.configuration.chat_access');
End_user_list_access := jResp.StringOf('custom_role.configuration.end_user_list_access');
End_user_profile_access := jResp.StringOf('custom_role.configuration.end_user_profile_access');
Explore_access := jResp.StringOf('custom_role.configuration.explore_access');
Forum_access := jResp.StringOf('custom_role.configuration.forum_access');
Forum_access_restricted_content := jResp.StringOf('custom_role.configuration.forum_access_restricted_content');
Group_access := jResp.StringOf('custom_role.configuration.group_access');
Light_agent := jResp.StringOf('custom_role.configuration.light_agent');
Macro_access := jResp.StringOf('custom_role.configuration.macro_access');
Manage_business_rules := jResp.StringOf('custom_role.configuration.manage_business_rules');
Manage_contextual_workspaces := jResp.StringOf('custom_role.configuration.manage_contextual_workspaces');
Manage_dynamic_content := jResp.StringOf('custom_role.configuration.manage_dynamic_content');
Manage_extensions_and_channels := jResp.StringOf('custom_role.configuration.manage_extensions_and_channels');
Manage_facebook := jResp.StringOf('custom_role.configuration.manage_facebook');
Manage_organization_fields := jResp.StringOf('custom_role.configuration.manage_organization_fields');
Manage_ticket_fields := jResp.StringOf('custom_role.configuration.manage_ticket_fields');
Manage_ticket_forms := jResp.StringOf('custom_role.configuration.manage_ticket_forms');
Manage_user_fields := jResp.StringOf('custom_role.configuration.manage_user_fields');
Moderate_forums := jResp.StringOf('custom_role.configuration.moderate_forums');
Organization_editing := jResp.StringOf('custom_role.configuration.organization_editing');
Organization_notes_editing := jResp.StringOf('custom_role.configuration.organization_notes_editing');
Report_access := jResp.StringOf('custom_role.configuration.report_access');
Side_conversation_create := jResp.StringOf('custom_role.configuration.side_conversation_create');
Ticket_access := jResp.StringOf('custom_role.configuration.ticket_access');
Ticket_comment_access := jResp.StringOf('custom_role.configuration.ticket_comment_access');
Ticket_deletion := jResp.StringOf('custom_role.configuration.ticket_deletion');
Ticket_editing := jResp.StringOf('custom_role.configuration.ticket_editing');
Ticket_merge := jResp.StringOf('custom_role.configuration.ticket_merge');
Ticket_tag_editing := jResp.StringOf('custom_role.configuration.ticket_tag_editing');
Twitter_search_access := jResp.StringOf('custom_role.configuration.twitter_search_access');
User_view_access := jResp.StringOf('custom_role.configuration.user_view_access');
View_access := jResp.StringOf('custom_role.configuration.view_access');
View_deleted_tickets := jResp.StringOf('custom_role.configuration.view_deleted_tickets');
Voice_access := jResp.StringOf('custom_role.configuration.voice_access');
Voice_dashboard_access := jResp.StringOf('custom_role.configuration.voice_dashboard_access');
Created_at := jResp.StringOf('custom_role.created_at');
Description := jResp.StringOf('custom_role.description');
Id := jResp.StringOf('custom_role.id');
Team_member_count := jResp.StringOf('custom_role.team_member_count');
Updated_at := jResp.StringOf('custom_role.updated_at');

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create Custom Role",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_roles",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_roles"
      ]
    },
    "description": "#### Availability\n\n* Accounts on the Enterprise plan or above\n\n#### Allowed for\n\n* Administrators\n* Agents with the `manage_roles` permission\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/custom_roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_roles"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_role\": {\n    \"name\": \"<string>\",\n    \"role_type\": \"<integer>\",\n    \"configuration\": {\n      \"assign_tickets_to_any_group\": \"<boolean>\",\n      \"chat_access\": \"<boolean>\",\n      \"end_user_list_access\": \"<string>\",\n      \"end_user_profile_access\": \"<string>\",\n      \"explore_access\": \"<string>\",\n      \"forum_access\": \"<string>\",\n      \"forum_access_restricted_content\": \"<boolean>\",\n      \"group_access\": \"<boolean>\",\n      \"light_agent\": \"<boolean>\",\n      \"macro_access\": \"<string>\",\n      \"manage_business_rules\": \"<boolean>\",\n      \"manage_contextual_workspaces\": \"<boolean>\",\n      \"manage_dynamic_content\": \"<boolean>\",\n      \"manage_extensions_and_channels\": \"<boolean>\",\n      \"manage_facebook\": \"<boolean>\",\n      \"manage_organization_fields\": \"<boolean>\",\n      \"manage_ticket_fields\": \"<boolean>\",\n      \"manage_ticket_forms\": \"<boolean>\",\n      \"manage_user_fields\": \"<boolean>\",\n      \"moderate_forums\": \"<boolean>\",\n      \"organization_editing\": \"<boolean>\",\n      \"organization_notes_editing\": \"<boolean>\",\n      \"report_access\": \"<string>\",\n      \"side_conversation_create\": \"<boolean>\",\n      \"ticket_access\": \"<string>\",\n      \"ticket_comment_access\": \"<string>\",\n      \"ticket_deletion\": \"<boolean>\",\n      \"ticket_editing\": \"<boolean>\",\n      \"ticket_merge\": \"<boolean>\",\n      \"ticket_tag_editing\": \"<boolean>\",\n      \"twitter_search_access\": \"<boolean>\",\n      \"user_view_access\": \"<string>\",\n      \"view_access\": \"<string>\",\n      \"view_deleted_tickets\": \"<boolean>\",\n      \"voice_access\": \"<boolean>\",\n      \"voice_dashboard_access\": \"<boolean>\"\n    },\n    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"team_member_count\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}