POST/desk/api/v2/smartinboxes.json

Create a new smartinbox.

Body Params

SmartInbox represents a SmartInbox.

    • Name
      conditions
      Type
      array
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      description
      Type
      string
      Description
      Description is the description of this inbox.
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      groupBy
      Type
      string
      Description
      GroupBy is allows grouping results by assignee or type.
    • Name
      groups
      Type
      array
      Description
      Groups is a list of aggregate results when GroupBy is specified.
    • Name
      id
      Type
      integer
      Description
      ID is the unique ID for this smart inbox.
    • Name
      isShared
      Type
      boolean
      Description
      IsShared is true if the smart inbox is shared among all users.
    • Name
      name
      Type
      string
      Description
      Name is the name of this smart inbox.
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      total
      Type
      integer
      Description
      Total is the count of all tickets that fulfill the requested conditions.
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object
    • Name
      user
      Type
      object
    • Name
      users
      Type
      array
      Description
      users are users who have access to this smart inbox

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      SmartInboxAPIBody handles the get/create/update request/response for smartinbox.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    SmartInboxAPIBody
    {
      "included": {
        "conditions": [
          {
            "createdBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "customfield": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "customfieldoption": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "deletedAt": "2024-04-18T11:10:29.278Z",
            "deletedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "field": 0,
            "filter_args": {
              "aggregate": {
                "Distinct": true,
                "Field": "string",
                "Operation": "string"
              },
              "bulkDryExecute": true,
              "fields": [
                "string"
              ],
              "filter": [
                "string"
              ],
              "id": 0,
              "ids": [
                0
              ],
              "includes": [
                "string"
              ],
              "orderBy": "string",
              "orderMode": "asc",
              "page": 0,
              "pageOffset": 0,
              "pageSize": 0,
              "skipAggregation": true
            },
            "id": 0,
            "matchRequirement": "string",
            "operator": 0,
            "state": "string",
            "updatedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "value": "string"
          }
        ],
        "users": [
          {
            "autoFollowOnCC": true,
            "avatarURL": "string",
            "createdAt": "2024-04-18T11:10:29.278Z",
            "createdBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "deletedAt": "2024-04-18T11:10:29.278Z",
            "deletedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "editMethod": "string",
            "email": "string",
            "filter_args": {
              "aggregate": {
                "Distinct": true,
                "Field": "string",
                "Operation": "string"
              },
              "bulkDryExecute": true,
              "fields": [
                "string"
              ],
              "filter": [
                "string"
              ],
              "id": 0,
              "ids": [
                0
              ],
              "includes": [
                "string"
              ],
              "orderBy": "string",
              "orderMode": "asc",
              "page": 0,
              "pageOffset": 0,
              "pageSize": 0,
              "skipAggregation": true
            },
            "firstName": "string",
            "id": 0,
            "isAppOwner": true,
            "isPartTime": true,
            "lastName": "string",
            "ldKey": "string",
            "onboarding": {
              "addedFirstInbox": true,
              "bookmarkPage": true,
              "checkDeskHelpSite": true,
              "checkSampleInbox": true,
              "dismissedWelcome": true,
              "exploreHelpsites": true,
              "exploreReports": true,
              "inviteTeam": true,
              "repliedToFirstTicket": true,
              "reviewedCompanySettings": true,
              "reviewedProfile": true
            },
            "projectsCompanyId": 0,
            "reviewer": true,
            "role": "string",
            "sendPushNotifications": true,
            "sendWebNotifications": true,
            "state": "string",
            "ticketReplyRedirect": "string",
            "timeFormatId": 0,
            "timezoneId": 0,
            "trainingWheelsEnrollment": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "updatedAt": "2024-04-18T11:10:29.278Z",
            "updatedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            }
          }
        ]
      },
      "smartinbox": {
        "conditions": [
          {
            "delete": true,
            "id": 0,
            "meta": {},
            "type": 0
          }
        ],
        "createdAt": "2024-04-18T11:10:29.278Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-04-18T11:10:29.278Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "description": "string",
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "groupBy": "string",
        "groups": [
          {
            "count": 0,
            "icon": "string",
            "id": 0,
            "name": "string"
          }
        ],
        "id": 0,
        "isShared": true,
        "name": "string",
        "state": "string",
        "total": 0,
        "updatedAt": "2024-04-18T11:10:29.278Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "user": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "users": [
          {
            "delete": true,
            "id": 0,
            "meta": {},
            "type": 0
          }
        ]
      }
    }