PATCH/desk/api/v2/triggertasktemplates/{id}.json
Update a triggertasktemplate.
Update all the given properties for this resource. Any omitted properties will be unchanged.
Path Params
- Name
id
- Type
- integer
- required
- Description
Body Params
TriggerTaskTemplate represents a TriggerTaskTemplate.
- Name
company
- Type
- object
- 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
- Name
dueDateUnixOffset
- Type
- integer
- Name
estimateMinutes
- Type
- integer
- Name
filter_args
- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
hasDeskTickets
- Type
- boolean
- Name
id
- Type
- integer
- Name
name
- Type
- string
- Description
- Task specific
- Name
notify
- Type
- boolean
- Name
priority
- Type
- integer
- Name
private
- Type
- boolean
- Name
project
- Type
- object
- Name
startDateUnixOffset
- 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
status
- Type
- integer
- Name
tasklist
- Type
- object
- 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
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
TriggerTaskTemplateAPIBody handles the get/create/update request/response for triggertasktemplate.
- 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
TriggerTaskTemplateAPIBody
{
"included": {
"users": [
{
"autoFollowOnCC": true,
"avatarURL": "string",
"createdAt": "2024-12-05T12:31:07.476Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"deletedAt": "2024-12-05T12:31:07.476Z",
"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-05T12:31:07.476Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
}
}
]
},
"triggertasktemplate": {
"company": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"createdAt": "2024-12-05T12:31:07.476Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"deletedAt": "2024-12-05T12:31:07.476Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"description": "string",
"dueDateUnixOffset": 0,
"estimateMinutes": 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
},
"hasDeskTickets": true,
"id": 0,
"name": "string",
"notify": true,
"priority": 0,
"private": true,
"project": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"startDateUnixOffset": 0,
"state": "string",
"status": 0,
"tasklist": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"updatedAt": "2024-12-05T12:31:07.476Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
}
}
}