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

Update a cannedresponse.

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

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

CannedResponseAPIBody handles request/response for a single canned response

    • Name
      cannedresponse
      Type
      object
      Description
      CannedResponse is a stored response that agents can provide to customers for common inquiries.s
    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      CannedResponseAPIBody handles request/response for a single canned 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.

    Examples

    200 OK

    CannedResponseAPIBody
    {  "cannedresponse": {    "createdAt": "2025-01-29T11:35:55.330Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2025-01-29T11:35:55.330Z",    "deletedBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },
    Download Swagger