API Reference

Zendesk Connector for AWS Mobile Hub

This page refers to the AWS Mobile Hub Connectors feature that connects your mobile app to Zendesk SaaS APIs.
For more information, see Connectors in the AWS Mobile Hub Developer Guide

zendesknative

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
post /attachments
Upload a file (createAttachment)

Request body

file (required)
Body Parameter — data to be uploaded.

Request headers

Query parameters

fileName (required)
Query Parameter — Name of the file
token (optional)
Query Parameter — optional token

Return type

attachment

Example data

Content-Type: application/json
{
  "thumbnail" : [ {
    "content_type" : "aeiou",
    "size" : 123,
    "file_name" : "aeiou",
    "content_url" : "aeiou",
    "id" : 123456789
  } ],
  "content_type" : "aeiou",
  "size" : 123,
  "file_name" : "aeiou",
  "content_url" : "aeiou",
  "id" : 123456789
}

Responses

200

OK - Everything worked as expected attachment

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

409

Conflict - If a resource being created already exists defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
post /tickets
Create a ticket. (createTicket)

Request body

body (required)
Body Parameter — Ticket to create

Request headers

Return type

ticket

Example data

Content-Type: application/json
{
  "subject" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "description" : "aeiou",
  "external_id" : "aeiou",
  "type" : "aeiou",
  "via" : { },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "problem_id" : 123456789,
  "due_at" : "2000-01-23T04:56:07.000+00:00",
  "id" : 123456789,
  "assignee_id" : 123456789,
  "raw_subject" : "aeiou",
  "forum_topic_id" : 123456789,
  "custom_fields" : [ {
    "id" : 123456789,
    "value" : "aeiou"
  } ],
  "allow_channelback" : true,
  "satisfaction_rating" : {
    "score" : "aeiou",
    "comment" : "aeiou",
    "id" : 123456789
  },
  "submitter_id" : 123456789,
  "priority" : "aeiou",
  "collaborator_ids" : [ 123456789 ],
  "url" : "aeiou",
  "tags" : [ "aeiou" ],
  "brand_id" : 123456789,
  "ticket_form_id" : 123456789,
  "sharing_agreement_ids" : [ 123456789 ],
  "group_id" : 123456789,
  "organization_id" : 123456789,
  "recipient" : "aeiou",
  "is_public" : true,
  "has_incidents" : true,
  "status" : "aeiou",
  "requester_id" : 123456789
}

Responses

200

OK - Everything worked as expected ticket

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

409

Conflict - If a resource being created already exists defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
post /ticket-fields
Create ticket fields (createTicketField)

Request body

body (required)
Body Parameter — ticket-fields to be created

Request headers

Return type

ticketField

Example data

Content-Type: application/json
{
  "raw_title" : "aeiou",
  "collapsed_for_agents" : true,
  "visible_in_portal" : true,
  "description" : "aeiou",
  "active" : true,
  "raw_title_in_portal" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "type" : "aeiou",
  "title" : "aeiou",
  "raw_description" : "aeiou",
  "url" : "aeiou",
  "required" : true,
  "editable_in_portal" : true,
  "required_in_portal" : true,
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "system_field_options" : [ {
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "removable" : true,
  "regexp_for_validation" : "aeiou",
  "id" : 123456789,
  "position" : 123,
  "tag" : "aeiou",
  "title_in_portal" : "aeiou"
}

Responses

200

OK - Everything worked as expected ticketField

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

409

Conflict - If a resource being created already exists defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
post /users
Create a user (createUser)

Request body

users (required)
Body Parameter — The users object

Request headers

Return type

user

Example data

Content-Type: application/json
{
  "shared" : true,
  "last_login_at" : "2000-01-23T04:56:07.000+00:00",
  "notes" : "aeiou",
  "role" : "aeiou",
  "signature" : "aeiou",
  "shared_agent" : true,
  "custom_role_id" : 123456789,
  "moderator" : true,
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "external_id" : "aeiou",
  "locale" : "aeiou",
  "locale_id" : 123456789,
  "user_fields" : {
    "user_decimal" : 1.3579000000000001069366817318950779736042022705078125,
    "user_dropdown" : "aeiou",
    "user_date" : "aeiou"
  },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "alias" : "aeiou",
  "details" : "aeiou",
  "id" : 123456789,
  "email" : "aeiou",
  "restricted_agent" : true,
  "only_private_comments" : true,
  "verified" : true,
  "active" : true,
  "photo" : {
    "content_type" : "aeiou",
    "size" : 123,
    "name" : "aeiou",
    "content_url" : "aeiou",
    "id" : 123456789,
    "thumbnails" : [ {
      "content_type" : "aeiou",
      "size" : 123,
      "name" : "aeiou",
      "content_url" : "aeiou",
      "id" : 123456789
    } ]
  },
  "time_zone" : "aeiou",
  "url" : "aeiou",
  "suspended" : true,
  "tags" : [ "aeiou" ],
  "phone" : "aeiou",
  "organization_id" : 123456789,
  "name" : "aeiou",
  "ticket_restriction" : "aeiou"
}

Responses

200

OK - Everything worked as expected user

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

409

Conflict - If a resource being created already exists defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
delete /attachments/{id}
Delete an attachment by Id. (deleteAttachmentById)

Path parameters

id (required)
Path Parameter — The Id of the attachment.

Request headers

Responses

200

OK - Everything worked as expected

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
delete /tickets/{id}
Delete a ticket by Id. (deleteTicketById)

Path parameters

id (required)
Path Parameter — The whatever ID

Request headers

Responses

200

OK - Everything worked as expected

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
delete /ticket-fields/{id}
Delete ticket fields. (deleteTicketFieldById)

Path parameters

id (required)
Path Parameter — The text fields ID

Request headers

Responses

200

OK - Everything worked as expected

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
delete /users/{id}
Delete a user by Id (deleteUserById)

Path parameters

id (required)
Path Parameter — The user ID

Request headers

Responses

200

OK - Everything worked as expected

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /attachments/{id}
Retrieve an attachment by Id (getAttachmentById)

Path parameters

id (required)
Path Parameter — The ID of the attachment

Request headers

Return type

attachment

Example data

Content-Type: application/json
{
  "thumbnail" : [ {
    "content_type" : "aeiou",
    "size" : 123,
    "file_name" : "aeiou",
    "content_url" : "aeiou",
    "id" : 123456789
  } ],
  "content_type" : "aeiou",
  "size" : 123,
  "file_name" : "aeiou",
  "content_url" : "aeiou",
  "id" : 123456789
}

Responses

200

OK - Everything worked as expected attachment

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /search
Unified search API that returns tickets, users, and organizations. (getSearch)

Request headers

Query parameters

query (optional)
Query Parameter — search query to send
pageSize (optional)
Query Parameter —
continuationToken (optional)
Query Parameter —

Return type

searchList

Example data

Content-Type: application/json
{
  "nextContinuationToken" : "aeiou",
  "data" : [ {
    "notes" : "aeiou",
    "subject" : "aeiou",
    "moderator" : true,
    "type" : "aeiou",
    "via" : { },
    "locale_id" : 123456789,
    "user_fields" : {
      "user_decimal" : 1.3579000000000001069366817318950779736042022705078125,
      "user_dropdown" : "aeiou",
      "user_date" : "aeiou"
    },
    "details" : "aeiou",
    "id" : 123456789,
    "raw_subject" : "aeiou",
    "two_factor_auth_enabled" : true,
    "custom_fields" : [ {
      "id" : 123456789,
      "value" : "aeiou"
    } ],
    "allow_channelback" : true,
    "active" : true,
    "priority" : "aeiou",
    "suspended" : true,
    "tags" : [ "aeiou" ],
    "brand_id" : 123456789,
    "phone" : "aeiou",
    "organization_id" : 123456789,
    "name" : "aeiou",
    "has_incidents" : true,
    "fields" : [ {
      "id" : 123456789,
      "value" : true
    } ],
    "ticket_restriction" : "aeiou",
    "chat_only" : true,
    "status" : "aeiou",
    "requester_id" : 123456789,
    "shared" : true,
    "role" : "aeiou",
    "shared_agent" : true,
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "description" : "aeiou",
    "external_id" : "aeiou",
    "locale" : "aeiou",
    "organization_fields" : {
      "autotaskaccountid" : "aeiou"
    },
    "updated_at" : "2000-01-23T04:56:07.000+00:00",
    "alias" : "aeiou",
    "shared_comments" : true,
    "email" : "aeiou",
    "assignee_id" : 123456789,
    "restricted_agent" : true,
    "shared_tickets" : true,
    "result_type" : "aeiou",
    "only_private_comments" : true,
    "verified" : true,
    "submitter_id" : 123456789,
    "time_zone" : "aeiou",
    "url" : "aeiou",
    "domain_names" : [ "aeiou" ],
    "ticket_form_id" : 123456789,
    "deleted" : true,
    "group_id" : 123456789,
    "is_public" : true
  } ],
  "returnedCount" : ""
}

Responses

200

OK - Everything worked as expected searchList

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /statuses/{id}
Get Job Statuses by id. (getStatuseById)

Path parameters

id (required)
Path Parameter — The whatever ID

Request headers

Return type

status

Example data

Content-Type: application/json
{
  "total" : 123456789,
  "progress" : 123456789,
  "id" : "aeiou",
  "message" : "aeiou",
  "results" : [ {
    "success" : true,
    "action" : "aeiou",
    "id" : 123456789,
    "title" : "aeiou",
    "errors" : "aeiou",
    "status" : "aeiou"
  } ],
  "url" : "aeiou",
  "status" : "aeiou"
}

Responses

200

OK - Everything worked as expected status

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /tickets/{id}
Get a ticket by id (getTicketById)

Path parameters

id (required)
Path Parameter — The ticket ID

Request headers

Return type

ticket

Example data

Content-Type: application/json
{
  "subject" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "description" : "aeiou",
  "external_id" : "aeiou",
  "type" : "aeiou",
  "via" : { },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "problem_id" : 123456789,
  "due_at" : "2000-01-23T04:56:07.000+00:00",
  "id" : 123456789,
  "assignee_id" : 123456789,
  "raw_subject" : "aeiou",
  "forum_topic_id" : 123456789,
  "custom_fields" : [ {
    "id" : 123456789,
    "value" : "aeiou"
  } ],
  "allow_channelback" : true,
  "satisfaction_rating" : {
    "score" : "aeiou",
    "comment" : "aeiou",
    "id" : 123456789
  },
  "submitter_id" : 123456789,
  "priority" : "aeiou",
  "collaborator_ids" : [ 123456789 ],
  "url" : "aeiou",
  "tags" : [ "aeiou" ],
  "brand_id" : 123456789,
  "ticket_form_id" : 123456789,
  "sharing_agreement_ids" : [ 123456789 ],
  "group_id" : 123456789,
  "organization_id" : 123456789,
  "recipient" : "aeiou",
  "is_public" : true,
  "has_incidents" : true,
  "status" : "aeiou",
  "requester_id" : 123456789
}

Responses

200

OK - Everything worked as expected ticket

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /ticket-fields/{id}
Get the ticket-fields by id (getTicketFieldById)

Path parameters

id (required)
Path Parameter — The ticket field ID

Request headers

Return type

ticketField

Example data

Content-Type: application/json
{
  "raw_title" : "aeiou",
  "collapsed_for_agents" : true,
  "visible_in_portal" : true,
  "description" : "aeiou",
  "active" : true,
  "raw_title_in_portal" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "type" : "aeiou",
  "title" : "aeiou",
  "raw_description" : "aeiou",
  "url" : "aeiou",
  "required" : true,
  "editable_in_portal" : true,
  "required_in_portal" : true,
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "system_field_options" : [ {
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "removable" : true,
  "regexp_for_validation" : "aeiou",
  "id" : 123456789,
  "position" : 123,
  "tag" : "aeiou",
  "title_in_portal" : "aeiou"
}

Responses

200

OK - Everything worked as expected ticketField

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /ticket-fields
Retrieve a list of ticket fields (getTicketFields)

Request headers

Query parameters

pageSize (optional)
Query Parameter — The number of resources to return in a given page
continuationToken (optional)
Query Parameter — The page number of resources to retrieve

Return type

ticketFieldList

Example data

Content-Type: application/json
{
  "nextContinuationToken" : "aeiou",
  "data" : [ {
    "raw_title" : "aeiou",
    "collapsed_for_agents" : true,
    "visible_in_portal" : true,
    "description" : "aeiou",
    "active" : true,
    "raw_title_in_portal" : "aeiou",
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "type" : "aeiou",
    "title" : "aeiou",
    "raw_description" : "aeiou",
    "url" : "aeiou",
    "required" : true,
    "editable_in_portal" : true,
    "required_in_portal" : true,
    "updated_at" : "2000-01-23T04:56:07.000+00:00",
    "system_field_options" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "removable" : true,
    "regexp_for_validation" : "aeiou",
    "id" : 123456789,
    "position" : 123,
    "tag" : "aeiou",
    "title_in_portal" : "aeiou"
  } ],
  "returnedCount" : ""
}

Responses

200

OK - Everything worked as expected ticketFieldList

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /tickets
Fetch a list of tickets (getTickets)

Request headers

Query parameters

sortOrder (optional)
Query Parameter — Sort order while getting the tickets
sortby (optional)
Query Parameter — Sort by property name
pageSize (optional)
Query Parameter — The number of resources to return in a given page
continuationToken (optional)
Query Parameter — The page number of resources to retrieve

Return type

ticketList

Example data

Content-Type: application/json
{
  "nextContinuationToken" : "aeiou",
  "data" : [ {
    "subject" : "aeiou",
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "description" : "aeiou",
    "external_id" : "aeiou",
    "type" : "aeiou",
    "via" : { },
    "updated_at" : "2000-01-23T04:56:07.000+00:00",
    "problem_id" : 123456789,
    "due_at" : "2000-01-23T04:56:07.000+00:00",
    "id" : 123456789,
    "assignee_id" : 123456789,
    "raw_subject" : "aeiou",
    "forum_topic_id" : 123456789,
    "custom_fields" : [ {
      "id" : 123456789,
      "value" : "aeiou"
    } ],
    "allow_channelback" : true,
    "satisfaction_rating" : {
      "score" : "aeiou",
      "comment" : "aeiou",
      "id" : 123456789
    },
    "submitter_id" : 123456789,
    "priority" : "aeiou",
    "collaborator_ids" : [ 123456789 ],
    "url" : "aeiou",
    "tags" : [ "aeiou" ],
    "brand_id" : 123456789,
    "ticket_form_id" : 123456789,
    "sharing_agreement_ids" : [ 123456789 ],
    "group_id" : 123456789,
    "organization_id" : 123456789,
    "recipient" : "aeiou",
    "is_public" : true,
    "has_incidents" : true,
    "status" : "aeiou",
    "requester_id" : 123456789
  } ],
  "returnedCount" : ""
}

Responses

200

OK - Everything worked as expected ticketList

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /tickets/{id}/comments
Retrieve a list of comments on a ticket (getTicketsComments)

Path parameters

id (required)
Path Parameter — The ticket ID

Request headers

Return type

ticketCommentList

Example data

Content-Type: application/json
{
  "nextContinuationToken" : "aeiou",
  "data" : [ {
    "metadata" : { },
    "attachments" : [ {
      "content_type" : "aeiou",
      "size" : 123,
      "file_name" : "aeiou",
      "content_url" : "aeiou",
      "id" : 123456789
    } ],
    "public" : true,
    "created_at" : "aeiou",
    "id" : 123456789,
    "type" : "aeiou",
    "body" : "aeiou",
    "author_id" : 123456789,
    "via" : { }
  } ],
  "returnedCount" : ""
}

Responses

200

OK - Everything worked as expected ticketCommentList

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /users/{id}
Fetch a user by id (getUserById)

Path parameters

id (required)
Path Parameter — The users ID

Request headers

Return type

user

Example data

Content-Type: application/json
{
  "shared" : true,
  "last_login_at" : "2000-01-23T04:56:07.000+00:00",
  "notes" : "aeiou",
  "role" : "aeiou",
  "signature" : "aeiou",
  "shared_agent" : true,
  "custom_role_id" : 123456789,
  "moderator" : true,
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "external_id" : "aeiou",
  "locale" : "aeiou",
  "locale_id" : 123456789,
  "user_fields" : {
    "user_decimal" : 1.3579000000000001069366817318950779736042022705078125,
    "user_dropdown" : "aeiou",
    "user_date" : "aeiou"
  },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "alias" : "aeiou",
  "details" : "aeiou",
  "id" : 123456789,
  "email" : "aeiou",
  "restricted_agent" : true,
  "only_private_comments" : true,
  "verified" : true,
  "active" : true,
  "photo" : {
    "content_type" : "aeiou",
    "size" : 123,
    "name" : "aeiou",
    "content_url" : "aeiou",
    "id" : 123456789,
    "thumbnails" : [ {
      "content_type" : "aeiou",
      "size" : 123,
      "name" : "aeiou",
      "content_url" : "aeiou",
      "id" : 123456789
    } ]
  },
  "time_zone" : "aeiou",
  "url" : "aeiou",
  "suspended" : true,
  "tags" : [ "aeiou" ],
  "phone" : "aeiou",
  "organization_id" : 123456789,
  "name" : "aeiou",
  "ticket_restriction" : "aeiou"
}

Responses

200

OK - Everything worked as expected user

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
get /users
Retrieve a list of users (getUsers)

Request headers

Query parameters

where (optional)
Query Parameter — The CEQL search expression.
role (optional)
Query Parameter — filter users depend upon role.for a single role. Possible values are "end-user", "agent", or "admin"
pageSize (optional)
Query Parameter — The number of resources to return in a given page
continuationToken (optional)
Query Parameter — The page number of resources to retrieve

Return type

userList

Example data

Content-Type: application/json
{
  "nextContinuationToken" : "aeiou",
  "data" : [ {
    "shared" : true,
    "last_login_at" : "2000-01-23T04:56:07.000+00:00",
    "notes" : "aeiou",
    "role" : "aeiou",
    "signature" : "aeiou",
    "shared_agent" : true,
    "custom_role_id" : 123456789,
    "moderator" : true,
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "external_id" : "aeiou",
    "locale" : "aeiou",
    "locale_id" : 123456789,
    "user_fields" : {
      "user_decimal" : 1.3579000000000001069366817318950779736042022705078125,
      "user_dropdown" : "aeiou",
      "user_date" : "aeiou"
    },
    "updated_at" : "2000-01-23T04:56:07.000+00:00",
    "alias" : "aeiou",
    "details" : "aeiou",
    "id" : 123456789,
    "email" : "aeiou",
    "restricted_agent" : true,
    "only_private_comments" : true,
    "verified" : true,
    "active" : true,
    "photo" : {
      "content_type" : "aeiou",
      "size" : 123,
      "name" : "aeiou",
      "content_url" : "aeiou",
      "id" : 123456789,
      "thumbnails" : [ {
        "content_type" : "aeiou",
        "size" : 123,
        "name" : "aeiou",
        "content_url" : "aeiou",
        "id" : 123456789
      } ]
    },
    "time_zone" : "aeiou",
    "url" : "aeiou",
    "suspended" : true,
    "tags" : [ "aeiou" ],
    "phone" : "aeiou",
    "organization_id" : 123456789,
    "name" : "aeiou",
    "ticket_restriction" : "aeiou"
  } ],
  "returnedCount" : ""
}

Responses

200

OK - Everything worked as expected userList

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
put /tickets/{id}
Update a ticket by id (replaceTicketById)

Path parameters

id (required)
Path Parameter — The ticket ID

Request body

body (optional)
Body Parameter — Updated ticket

Request headers

Return type

ticket

Example data

Content-Type: application/json
{
  "subject" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "description" : "aeiou",
  "external_id" : "aeiou",
  "type" : "aeiou",
  "via" : { },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "problem_id" : 123456789,
  "due_at" : "2000-01-23T04:56:07.000+00:00",
  "id" : 123456789,
  "assignee_id" : 123456789,
  "raw_subject" : "aeiou",
  "forum_topic_id" : 123456789,
  "custom_fields" : [ {
    "id" : 123456789,
    "value" : "aeiou"
  } ],
  "allow_channelback" : true,
  "satisfaction_rating" : {
    "score" : "aeiou",
    "comment" : "aeiou",
    "id" : 123456789
  },
  "submitter_id" : 123456789,
  "priority" : "aeiou",
  "collaborator_ids" : [ 123456789 ],
  "url" : "aeiou",
  "tags" : [ "aeiou" ],
  "brand_id" : 123456789,
  "ticket_form_id" : 123456789,
  "sharing_agreement_ids" : [ 123456789 ],
  "group_id" : 123456789,
  "organization_id" : 123456789,
  "recipient" : "aeiou",
  "is_public" : true,
  "has_incidents" : true,
  "status" : "aeiou",
  "requester_id" : 123456789
}

Responses

200

OK - Everything worked as expected ticket

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
put /ticket-fields/{id}
Update Ticket Fields (replaceTicketFieldById)

Path parameters

id (required)
Path Parameter — The ticket fields ID

Request body

body (required)
Body Parameter — ticket field to be created

Request headers

Return type

ticketField

Example data

Content-Type: application/json
{
  "raw_title" : "aeiou",
  "collapsed_for_agents" : true,
  "visible_in_portal" : true,
  "description" : "aeiou",
  "active" : true,
  "raw_title_in_portal" : "aeiou",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "type" : "aeiou",
  "title" : "aeiou",
  "raw_description" : "aeiou",
  "url" : "aeiou",
  "required" : true,
  "editable_in_portal" : true,
  "required_in_portal" : true,
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "system_field_options" : [ {
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "removable" : true,
  "regexp_for_validation" : "aeiou",
  "id" : 123456789,
  "position" : 123,
  "tag" : "aeiou",
  "title_in_portal" : "aeiou"
}

Responses

200

OK - Everything worked as expected ticketField

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up 
put /users/{id}
Update a user (replaceUserById)

Path parameters

id (required)
Path Parameter — The users ID

Request body

users (required)
Body Parameter — The users object

Request headers

Return type

user

Example data

Content-Type: application/json
{
  "shared" : true,
  "last_login_at" : "2000-01-23T04:56:07.000+00:00",
  "notes" : "aeiou",
  "role" : "aeiou",
  "signature" : "aeiou",
  "shared_agent" : true,
  "custom_role_id" : 123456789,
  "moderator" : true,
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "external_id" : "aeiou",
  "locale" : "aeiou",
  "locale_id" : 123456789,
  "user_fields" : {
    "user_decimal" : 1.3579000000000001069366817318950779736042022705078125,
    "user_dropdown" : "aeiou",
    "user_date" : "aeiou"
  },
  "updated_at" : "2000-01-23T04:56:07.000+00:00",
  "alias" : "aeiou",
  "details" : "aeiou",
  "id" : 123456789,
  "email" : "aeiou",
  "restricted_agent" : true,
  "only_private_comments" : true,
  "verified" : true,
  "active" : true,
  "photo" : {
    "content_type" : "aeiou",
    "size" : 123,
    "name" : "aeiou",
    "content_url" : "aeiou",
    "id" : 123456789,
    "thumbnails" : [ {
      "content_type" : "aeiou",
      "size" : 123,
      "name" : "aeiou",
      "content_url" : "aeiou",
      "id" : 123456789
    } ]
  },
  "time_zone" : "aeiou",
  "url" : "aeiou",
  "suspended" : true,
  "tags" : [ "aeiou" ],
  "phone" : "aeiou",
  "organization_id" : 123456789,
  "name" : "aeiou",
  "ticket_restriction" : "aeiou"
}

Responses

200

OK - Everything worked as expected user

400

Bad Request - Often due to a missing request parameter defaultErrorObject

401

Unauthorized - An invalid element token, user secret and/or org secret provided defaultErrorObject

403

Forbidden - Access to the resource by the provider is forbidden defaultErrorObject

404

Not found - The requested resource is not found defaultErrorObject

405

Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected defaultErrorObject

500

Server error - Something went wrong on the server defaultErrorObject

502

Server error - Internal server error defaultErrorObject
Up

Models

[ Jump to Methods ]

Table of Contents

  1. attachment
  2. attachments
  3. customFields
  4. defaultErrorObject
  5. fields
  6. metadata
  7. organizationFields
  8. photo
  9. results
  10. s3file
  11. satisfactionRating
  12. search
  13. searchList
  14. status
  15. systemFieldOptions
  16. thumbnail
  17. thumbnails
  18. ticket
  19. ticketComment
  20. ticketCommentList
  21. ticketField
  22. ticketFieldList
  23. ticketList
  24. user
  25. userFields
  26. userList
  27. via

attachment - Up

thumbnail (optional)
array[thumbnail]
content_type (optional)
String
size (optional)
Integer format: int32
file_name (optional)
String
content_url (optional)
String
id (optional)
Long format: int64

attachments - Up

content_type (optional)
String
size (optional)
Integer format: int32
file_name (optional)
String
content_url (optional)
String
id (optional)
Long format: int64

customFields - Up

id (optional)
Long format: int64
value (optional)
String

defaultErrorObject - Up

message (optional)
String
providerMessage (optional)
String

fields - Up

id (optional)
Long format: int64
value (optional)
Boolean

metadata - Up

organizationFields - Up

autotaskaccountid (optional)
String

photo - Up

content_type (optional)
String
size (optional)
Integer format: int32
name (optional)
String
content_url (optional)
String
id (optional)
Long format: int64
thumbnails (optional)
array[thumbnails]

results - Up

success (optional)
Boolean
action (optional)
String
id (optional)
Long format: int64
title (optional)
String
errors (optional)
String
status (optional)
String

s3file - Up

x-s3-filename (optional)
String
x-s3-bucketname (optional)
String

satisfactionRating - Up

score (optional)
String
comment (optional)
String
id (optional)
Long format: int64

search - Up

notes (optional)
String
subject (optional)
String
moderator (optional)
Boolean
type (optional)
String
via (optional)
via
locale_id (optional)
Long format: int64
user_fields (optional)
userFields
details (optional)
String
id (optional)
Long format: int64
raw_subject (optional)
String
two_factor_auth_enabled (optional)
Boolean
custom_fields (optional)
array[customFields]
allow_channelback (optional)
Boolean
active (optional)
Boolean
priority (optional)
String
suspended (optional)
Boolean
tags (optional)
array[String]
brand_id (optional)
Long format: int64
phone (optional)
String
organization_id (optional)
Long format: int64
name (optional)
String
has_incidents (optional)
Boolean
fields (optional)
array[fields]
ticket_restriction (optional)
String
chat_only (optional)
Boolean
status (optional)
String
requester_id (optional)
Long format: int64
shared (optional)
Boolean
role (optional)
String
shared_agent (optional)
Boolean
created_at (optional)
Date format: date-time
description (optional)
String
external_id (optional)
String
locale (optional)
String
organization_fields (optional)
organizationFields
updated_at (optional)
Date format: date-time
alias (optional)
String
shared_comments (optional)
Boolean
email (optional)
String
assignee_id (optional)
Long format: int64
restricted_agent (optional)
Boolean
shared_tickets (optional)
Boolean
result_type (optional)
String
only_private_comments (optional)
Boolean
verified (optional)
Boolean
submitter_id (optional)
Long format: int64
time_zone (optional)
String
url (optional)
String
domain_names (optional)
array[String]
ticket_form_id (optional)
Long format: int64
deleted (optional)
Boolean
group_id (optional)
Long format: int64
is_public (optional)
Boolean

searchList - Up

nextContinuationToken (optional)
String
data (optional)
array[search]
returnedCount (optional)
Integer

status - Up

total (optional)
Long format: int64
progress (optional)
Long format: int64
id (optional)
String
message (optional)
String
results (optional)
array[results]
url (optional)
String
status (optional)
String

systemFieldOptions - Up

name (optional)
String
value (optional)
String

thumbnail - Up

content_type (optional)
String
size (optional)
Integer format: int32
file_name (optional)
String
content_url (optional)
String
id (optional)
Long format: int64

thumbnails - Up

content_type (optional)
String
size (optional)
Integer format: int32
name (optional)
String
content_url (optional)
String
id (optional)
Long format: int64

ticket - Up

subject (optional)
String
created_at (optional)
Date format: date-time
description (optional)
String
external_id (optional)
String
type (optional)
String
via (optional)
via
updated_at (optional)
Date format: date-time
problem_id (optional)
Long format: int64
due_at (optional)
date format: date
id (optional)
Long format: int64
assignee_id (optional)
Long format: int64
raw_subject (optional)
String
forum_topic_id (optional)
Long format: int64
custom_fields (optional)
array[customFields]
allow_channelback (optional)
Boolean
satisfaction_rating (optional)
satisfactionRating
submitter_id (optional)
Long format: int64
priority (optional)
String
collaborator_ids (optional)
array[Long]
url (optional)
String
tags (optional)
array[String]
brand_id (optional)
Long format: int64
ticket_form_id (optional)
Long format: int64
sharing_agreement_ids (optional)
array[Long]
group_id (optional)
Long format: int64
organization_id (optional)
Long format: int64
recipient (optional)
String
is_public (optional)
Boolean
has_incidents (optional)
Boolean
status (optional)
String
requester_id (optional)
Long format: int64

ticketComment - Up

metadata (optional)
metadata
attachments (optional)
array[attachments]
public (optional)
Boolean
created_at (optional)
String
id (optional)
Long format: int64
type (optional)
String
body (optional)
String
author_id (optional)
Long format: int64
via (optional)
via

ticketCommentList - Up

nextContinuationToken (optional)
String
data (optional)
array[ticketComment]
returnedCount (optional)
Integer

ticketField - Up

raw_title (optional)
String
collapsed_for_agents (optional)
Boolean
visible_in_portal (optional)
Boolean
description (optional)
String
active (optional)
Boolean
raw_title_in_portal (optional)
String
created_at (optional)
Date format: date-time
type (optional)
String
title (optional)
String
raw_description (optional)
String
url (optional)
String
required (optional)
Boolean
editable_in_portal (optional)
Boolean
required_in_portal (optional)
Boolean
updated_at (optional)
Date format: date-time
system_field_options (optional)
array[systemFieldOptions]
removable (optional)
Boolean
regexp_for_validation (optional)
String
id (optional)
Long format: int64
position (optional)
Integer format: int32
tag (optional)
String
title_in_portal (optional)
String

ticketFieldList - Up

nextContinuationToken (optional)
String
data (optional)
array[ticketField]
returnedCount (optional)
Integer

ticketList - Up

nextContinuationToken (optional)
String
data (optional)
array[ticket]
returnedCount (optional)
Integer

user - Up

shared (optional)
Boolean
last_login_at (optional)
Date format: date-time
notes (optional)
String
role (optional)
String
signature (optional)
String
shared_agent (optional)
Boolean
custom_role_id (optional)
Long format: int64
moderator (optional)
Boolean
created_at (optional)
Date format: date-time
external_id (optional)
String
locale (optional)
String
locale_id (optional)
Long format: int64
user_fields (optional)
userFields
updated_at (optional)
Date format: date-time
alias (optional)
String
details (optional)
String
id (optional)
Long format: int64
email (optional)
String
restricted_agent (optional)
Boolean
only_private_comments (optional)
Boolean
verified (optional)
Boolean
active (optional)
Boolean
photo (optional)
photo
time_zone (optional)
String
url (optional)
String
suspended (optional)
Boolean
tags (optional)
array[String]
phone (optional)
String
organization_id (optional)
Long format: int64
name (optional)
String
ticket_restriction (optional)
String

userFields - Up

user_decimal (optional)
Double format: double
user_dropdown (optional)
String
user_date (optional)
String

userList - Up

nextContinuationToken (optional)
String
data (optional)
array[user]
returnedCount (optional)
Integer

via - Up

© 2016, Amazon.com Inc. or Affiliates. This documentation was created using Swagger Editor, located at http://swagger.io/swagger-editor.