POST/desk/api/v2/inboxes.json
Create a new inbox.
Body Params
Inbox represents a Inbox.
- Name
autoReplyEnabled
- Type
- boolean
- Name
autoReplyFromUserId
- Type
- integer
- Name
autoReplyMessage
- Type
- string
- Name
autoReplySubject
- Type
- string
- Name
clientOnly
- Type
- boolean
- 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
displayOrder
- Type
- integer
- Name
email
- Type
- string
- Name
emailForwardingState
- 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
forwardingAddress
- Type
- string
- Name
happinessRatingEnabled
- Type
- boolean
- Name
happinessRatingMessage
- Type
- string
- Name
iconImage
- Type
- string
- Name
id
- Type
- integer
- Name
inboxaliases
- Type
- array
- Name
inboxcnames
- Type
- array
- Name
inboxemailrefs
- Type
- array
- Name
includeTicketHistoryOnForward
- Type
- boolean
- Description
- IncludeTicketHistoryOnForward controls whether ticket history is included in forwarded tickets.
- Name
isAdmin
- Type
- boolean
- Name
isFreeDomain
- Type
- boolean
- Name
languageCode
- Type
- string
- Name
localPart
- Type
- string
- Name
name
- Type
- string
- Name
notificationOnly
- Type
- boolean
- Name
oauth2token
- Type
- object
- Name
onClosedLock
- Type
- string
- Name
onClosedWait
- Type
- integer
- Name
publicIconImage
- Type
- string
- Name
restricteddomains
- Type
- array
- Name
sendEmailsFrom
- Type
- string
- Name
signature
- Type
- string
- Name
smtpPassword
- Type
- string
- Name
smtpPort
- Type
- integer
- Name
smtpProvider
- Type
- string
- Name
smtpSecurity
- Type
- string
- Name
smtpServer
- Type
- string
- Name
smtpUsername
- Type
- string
- Name
spamThreshold
- Type
- integer
- Name
starred
- 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
syncAccountId
- Type
- integer
- Name
syncDays
- Type
- integer
- Name
syncSubscriptionId
- Type
- integer
- Name
synced
- Type
- boolean
- Name
ticketstatus
- Type
- object
- Name
tickettypes
- Type
- array
- Name
timeloggingEnabled
- Type
- boolean
- Name
timeloggingProjectId
- Type
- integer
- Name
triggers
- Type
- array
- Name
type
- Type
- string
- Description
- Type is either "shared" or "personal", with "shared" being the default.
- 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
useTeamworkMailServer
- Type
- boolean
- Name
user
- Type
- object
- Name
users
- Type
- array
- Name
usingOfficeHours
- Type
- boolean
- Name
verified
- Type
- boolean
Responses
- Code
- 201
- Type
- object
- Schema
- Description
- 201 Created
InboxAPIBody handles the get/create/update request/response for inbox.
- 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.
201 Created
InboxAPIBody
{ "customDKIM": "string", "inbox": { "autoReplyEnabled": true, "autoReplyFromUserId": 0, "autoReplyMessage": "string", "autoReplySubject": "string", "clientOnly": true, "createdAt": "2024-09-06T11:47:28.789Z", "createdBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "deletedAt": "2024-09-06T11:47:28.789Z",