PATCH/desk/api/v2/smartinboxes/update.json
Update multiple smartinboxes.
Update all the given properties for matching resources. Any omitted properties will be unchanged.
The following values are allowed in the [filter](/docs/desk/d667a6937d077-filtering-api-results) query parameter:
- id
- name
- description
- user
- isShared
- groupBy
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- deletedBy
- state
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
- 200
- Type
- object
- Schema
- Description
- 200 OK
BulkOpResponse is a bulk operation response
- 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.
200 OK
BulkOpResponse
{
"jobId": "string"
}