PATCH/desk/api/v2/tickettemplates/{id}.json

Update a tickettemplate.

Update all the given properties for this resource. Any omitted properties will be unchanged.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

TicketTemplate represents a TicketTemplate.

    • Name
      addToNewInboxes
      Type
      boolean
    • Name
      body
      Type
      string
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      customfields
      Type
      array
      Description
      The list of custom fields for available to the ticket
    • 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
      files
      Type
      array
      Description
      The list of files included in the template
    • 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
      inboxes
      Type
      array
      Description
      The list of inboxes the template is shared with
    • Name
      name
      Type
      string
    • Name
      priority
      Type
      object
    • Name
      source
      Type
      object
    • 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
      object
    • Name
      subject
      Type
      string
    • Name
      tags
      Type
      array
      Description
      The list of word the ticket was tagged with
    • Name
      type
      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
    • Name
      user
      Type
      object

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      TicketTemplateAPIBody handles the get/create/update request/response for tickettemplate.
    • 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

    TicketTemplateAPIBody
    {  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-04-18T11:10:28.760Z",