PUT/desk/api/v2/fields.json

Update filter fields for user.

Body Params

FilterField represents database entry for filters fields in Desk. Used by companyfield and customerfield.

    • Name
      bodyTemplate
      Type
      string
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      customfield
      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
      field
      Type
      string
    • Name
      fieldtype
      Type
      string
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      kind
      Type
      string
    • Name
      label
      Type
      string
    • Name
      locked
      Type
      boolean
    • Name
      minWidth
      Type
      number
    • Name
      orderable
      Type
      boolean
    • Name
      position
      Type
      integer
    • Name
      selected
      Type
      boolean
    • Name
      sortable
      Type
      boolean
    • 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
      template
      Type
      string
    • Name
      toggleable
      Type
      boolean
    • 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
      width
      Type
      number
    • Name
      widthUnit
      Type
      string

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      FilterFieldsAPIBody handles the listing response for filterfield.
    • Code
      304
      Description
      304 Not Modified No Data
    • 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

    200 OK

    FilterFieldsAPIBody
    {
  "fields": [
    {
      "bodyTemplate": "string",
      "createdAt": "2025-02-11T11:36:22.318Z",
      "createdBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "customfield": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "deletedAt": "2025-02-11T11:36:22.318Z",
      "deletedBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "field": "string",
      "fieldtype": "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
      },
      "id": 0,
      "kind": "string",
      "label": "string",
      "locked": true,
      "minWidth": 0,
      "orderable": true,
      "position": 0,
      "selected": true,
      "sortable": true,
      "state": "string",
      "template": "string",
      "toggleable": true,
      "updatedAt": "2025-02-11T11:36:22.318Z",
      "updatedBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "width": 0,
      "widthUnit": "string"
    }
  ],
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2025-02-11T11:36:22.318Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "deletedAt": "2025-02-11T11:36:22.318Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "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": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "updatedAt": "2025-02-11T11:36:22.318Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        }
      }
    ]
  },
  "meta": {
    "page": {
      "count": 0,
      "hasMore": true,
      "hasMorePages": true,
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "pages": 0,
      "records": 0
    }
  },
  "pagination": {
    "count": 0,
    "hasMore": true,
    "hasMorePages": true,
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "pages": 0,
    "records": 0
  }
}
    Download Swagger