POST/desk/api/v2/spamlists.json

Create a new spamlist.

Body Params

SpamList represents a SpamList.

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
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
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
term
Type
string
Name
type
Type
string
Name
updatedAt
Type
string
Name
updatedBy
Type
object

Responses

Code
201
Type
object
Schema
Description
201 Created
SpamListAPIBody handles the get/create/update request/response for spamlist.
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

SpamListAPIBody

{
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-12-19T16:02:34.102Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "deletedAt": "2024-12-19T16:02:34.102Z",
        "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": "2024-12-19T16:02:34.102Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        }
      }
    ]
  },
  "spamlist": {
    "createdAt": "2024-12-19T16:02:34.102Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    },
    "deletedAt": "2024-12-19T16:02:34.102Z",
    "deletedBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 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,
    "state": "string",
    "term": "string",
    "type": "string",
    "updatedAt": "2024-12-19T16:02:34.102Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    }
  }
}

Download Swagger