POST/desk/api/v2/threads/{id}/pinnednotes.json

Create a new pinnednote.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

PinnedNote represents a PinnedNote.

    • 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
      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
      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
      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

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      PinnedNoteAPIBody represents the request/response on pinnednotes get/create/patch
    • 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

    201 Created

    PinnedNoteAPIBody
    {  "included": {    "messages": [      {        "agentsNotified": [          {            "delete": true,            "id": 0,            "meta": {},            "type": 0          }        ],        "archivedTickets_id": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },
    Download Swagger