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

Update a sla.

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

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

SLA represents a SLA.

    • Name
      businesshours
      Type
      object
    • Name
      companies
      Type
      array
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      customers
      Type
      array
    • 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
      displayOrder
      Type
      integer
    • Name
      enabled
      Type
      boolean
    • 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
    • Name
      name
      Type
      string
    • Name
      notifications
      Type
      array
    • Name
      slacompanies
      Type
      array
    • Name
      slacustomers
      Type
      array
    • Name
      slainboxes
      Type
      array
    • Name
      slatags
      Type
      array
    • Name
      slathreads
      Type
      array
    • Name
      slaticketpriorities
      Type
      array
    • Name
      slatickettypes
      Type
      array
    • 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
      tags
      Type
      array
    • Name
      threads
      Type
      array
    • Name
      ticketpriorities
      Type
      array
    • Name
      tickettypes
      Type
      array
    • 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
      SLAAPIBody handles the get/create/update request/response for sla.
    • 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

    SLAAPIBody
    {  "included": {    "companies": [      {        "address": {          "delete": true,          "id": 0,          "meta": {            "additionalProp": "Unknown Type: any"          },          "type": 0        },        "avatarPath": "string",        "createdAt": "2025-07-07T10:26:43.648Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {