BUbuttondown
Books

Update Book

Changed on

Update a book's properties

patch/books/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/books/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Request body

titlestring nullable

The title of the book.

urlstring nullable

The URL where the book can be purchased or viewed.

image_urlstring nullable

The URL of the book's cover image.

descriptionstring nullable

A description of the book.

yearinteger nullable

The year the book was published.

isbnstring nullable

The ISBN of the book.

sharedboolean nullable

Whether the book is displayed publicly on the archive.

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

titlestring required

The title of the book.

urlstring

The URL where the book can be purchased or viewed.

image_urlstring

The URL of the book's cover image.

descriptionstring

A description of the book.

yearinteger nullable

The year the book was published.

isbnstring

The ISBN of the book.

sharedboolean

Whether the book is displayed publicly on the archive.

Changes

  • 228cc05ba97dRevision changes
    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      response property year list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security PermissionAuthenticationRequirement was removed from the API

    • info

      api tag Books added

    • info

      added the new optional request property

    • info

      for the path request parameter id, the format was generalized from uuid to no format

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status