Sign in
Guides

Update guide

Changed on

Updates an existing guide

patch/api/v1/guides/{id}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/guides/{id}
  • Auth: none declared

Path parameters

idstring required

Request body

descriptionstring nullable
titlestring nullable
visibility'private' | 'team' | 'public'

The visibility of the guide

Response

OK

Example response

{
  "guide": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "team_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}

Changes

  • 9330a2f45986Revision changes
    • breaking

      the response property / became nullable for the status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • febecbafa164Revision changes
    • info

      removed the pending_purge enum value from the / response property for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status