id-of-ticket-update

dci id-of-ticket-update ticketId

Partially updates a support request. Supports setting the request status and/or assignee. DoiT employees may set any of open, pending, hold, or solved and may set the assignee; customers may set only solved (parity with the console "mark as resolved" action) and may not set an assignee. closed is not settable via the API (Zendesk auto-closes from solved). The assignee is a DoiT-employee email, resolved server-side to a Zendesk agent; an email that does not resolve to an active agent returns 400. At least one mutable field must be present. The response echoes the fields that were applied.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "minProperties": 1,
  "properties": {
    "status": {
      "type": "string",
      "description": "The status to set on the request.",
      "enum": [
        "open",
        "pending",
        "hold",
        "solved"
      ]
    },
    "assignee": {
      "type": "string",
      "format": "email",
      "description": "Email of the DoiT employee to assign the request to,\nresolved to a Zendesk agent. DoiT employees only."
    }
  }
}

Responses

200 (application/json)

OK - Request updated. Echoes the fields that were applied.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "status": {
      "type": "string"
    },
    "assignee": {
      "type": "string"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: id-of-ticket-update, idofticketupdate