PUT/desk/api/v2/notifications/{id}.json

Update a Notification. If the notification is being marked as read then all

other notifications belonging to this ticket will also be marked as read.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

Notification represents a Notification.

    • Name
      conversation
      Type
      object
    • Name
      conversationCustomerContact
      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
      deliveryFailureReason
      Type
      string
    • Name
      deliveryStatus
      Type
      string
    • Name
      event
      Type
      string
    • Name
      eventState
      Type
      string
    • Name
      failures
      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
      id
      Type
      integer
    • Name
      kind
      Type
      object
      Description
      NotificationType defines a type of notification, i.e OnNewTicket
    • Name
      kinds
      Type
      object
      Description
      NotificationKinds represents all notification types that cause one notification
    • Name
      openFailureReason
      Type
      string
    • Name
      openStatus
      Type
      string
    • Name
      pinned
      Type
      boolean
    • Name
      read
      Type
      boolean
    • 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
      thread
      Type
      object
    • Name
      threadCustomerCreator
      Type
      object
    • Name
      threadUserCreator
      Type
      object
    • Name
      ticket
      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
      NotificationAPIBody handles the get/create/update request/response for notification.
    • 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

    NotificationAPIBody
    {  "included": {    "customers": [      {        "addMethod": "string",        "address": "string",        "avatarURL": "string",        "company": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },        "contacts": [          {            "delete": true,            "id": 0,            "meta": {},
    Download Swagger