PATCH/desk/api/v2/trainingwheels/enrollments/{userId}.json

Update a trainingwheelsenrollment.

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

Path Params

  • Name
    userId
    Type
    integer
    required
    Description

Body Params

TrainingWheelsEnrollment represents a TrainingWheelsEnrollment.

    • 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
      Description
      ID is the id of the enrollment. Note that in requests enrollments are identified by their user id, instead of this one.
    • Name
      inboxes
      Type
      array
      Description
      RelInboxes contains the relationship to those inboxes for which the user has an InboxTrainingWheelsEnrollment. As part of requests, this field is used to create/delete inbox enrollments.
    • Name
      isForAllInboxes
      Type
      boolean
      Description
      IsForAllInboxes=true means the user will be reviewed for tickets in any inbox. IsForAllInboxes=false means the user will be reviewed for tickets only in those inboxes which have a corresponding InboxTrainingWheelsEnrollment entry.
    • Name
      reviewPercentage
      Type
      integer
      Description
      ReviewPercentage is the percentage of the replies from an agent that will be reviewed.
    • 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
      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
      TrainingWheelsEnrollmentAPIBody handles the get/create/update request/response for trainingwheelsenrollment.
    • 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

    TrainingWheelsEnrollmentAPIBody
    {  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-12-19T16:02:34.102Z",
    Download Swagger