PATCH/desk/api/v2/installations.json

Update a installation.

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

In particular, to change the owner of the app (installation), use body: { "installation": { "appOwner": { "id": <user_id> } } } Only the current owner can choose a new one. Only a user with admin role can be chosen to be the new owner.

Body Params

InstallationAPIBody handles the get/create/update request/response for installation.

    • 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
      installation
      Type
      object
      Description
      Installation represents an Installation.
    • Name
      jobID
      Type
      string
    • Name
      pusher
      Type
      object

    Responses

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

    InstallationAPIBody
    {  "included": {    "users": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-07-26T20:26:10.533Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },        "deletedAt": "2024-07-26T20:26:10.533Z",        "deletedBy": {          "delete": true,          "id": 0,          "meta": {},
    Download Swagger