PHphilterd
Custom Lists

Replace a list.

Changed on

Replaces the items of an existing list with the request body's items. description is optional: left out, the list keeps its description; given as an empty string, it is cleared. Requires the lists:write scope.

put/api/lists/{name}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/lists/{name}
  • Auth
    HTTP bearer

Path parameters

namestring required

Query parameters

ownerstring

Headers

Authorizationstring required

Request body

descriptionstring

The list's description. On create, left out means an empty string. On replace, left out keeps the list's description, and an empty string clears it.

itemsstring[] required

The list's items. Required, with at least one item that is not empty.

Response

The list was replaced.

fieldstring

For a request refused as invalid, the parameter or body field that was invalid, when one is.

messagestring

What happened, written for a person to read. It may change; use reason in code.

reasonstring

For an error, why the request was refused, as a stable code a client can act on. The codes are listed in the API documentation under Errors.

Changes

  • 25d87e0bb8f0Revision changes
    • breaking

      added the new required request property

    • breaking

      the request's body type changed from array to object

    • warning

      deleted the query request parameter description

    • info

      added the new optional request property

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status