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

Update a inbox.

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

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

InboxAPIBody handles the get/create/update request/response for inbox.

    • Name
      customDKIM
      Type
      string
    • Name
      inbox
      Type
      object
      Description
      Inbox represents a Inbox.
    • 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.
    • Name
      ticketcounts
      Type
      dictionary[string, object]

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      InboxAPIBody handles the get/create/update request/response for inbox.
    • 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

    InboxAPIBody
    {  "customDKIM": "string",  "inbox": {    "autoReplyEnabled": true,    "autoReplyFromUserId": 0,    "autoReplyMessage": "string",    "autoReplySubject": "string",    "clientOnly": true,    "createdAt": "2025-02-11T11:36:38.358Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2025-02-11T11:36:38.358Z",
    Download Swagger