Batch

Utility endpoint to submit a batch of sequenced, dependent requests.

The requests are guaranteed to be performed sequentially in the order given in the request and will abort if any request does not return a status-2xx response. For example, this can be used to ban and delete all of a user's messages by sequencing the ban followed by the delete_all: if the ban fails (e.g. because permission is denied) then the delete_all will not occur. The batch body and response are identical to the /batch endpoint; requests that are not carried out because of an earlier failure will have a response code of 412 (Precondition Failed)."

post/sequence

Request body

— unresolved $ref

Response

— unresolved $ref

Changes

Changed in 3 of the 21 revisions of this API.322

    • the items/bytes request property type/format changed from /binary to string/binary

      request-property-type-changed

  • 2592dbb0841412See the full diff
    • the items/bytes request property type/format changed from string/byte to /binary

      request-property-type-changed

    • added the new optional request property items/b64

      new-optional-request-property

    • added the new optional request property items/headers

      new-optional-request-property

  • fbd68862ef1712See the full diff
    • the items/bytes request property type/format changed from string/binary to string/byte

      request-property-type-changed

    • removed the request property items/b64

      request-property-removed

    • removed the request property items/headers

      request-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog