Payload CMS icon

Payload CMS

Interact with Payload CMS collections and globals

Endpoint → Post

AI-generated

Summary

Create a new document in a selected Payload CMS endpoint

Inputs

  • endpoint (required) — Choose the endpoint to operate on
  • data (required) — The data to send (JSON format)
  • depth — How deep to populate relationships
  • limit — Maximum number of documents to return
  • page — Page number for pagination
  • sort — Sort field (use - for descending, e.g., -createdAt)
  • where — Where clause for filtering (JSON format)
  • select — Fields to select (comma-separated)
  • locale — Locale for localized content
  • upload — Name of the binary property that contains the file to upload
  • query — Query parameters to add to the request url

Output shape

the API response body (JSON)

Success returns the response data; errors are handled separately and may be returned as error objects when continueOnFail is enabled

Examples

Example 1: Create a new blog post

Select Endpoint = '/api/posts', set Data = {"title":"Hello","content":"..."}

Example 2: Upload a file to a storage endpoint

Choose Endpoint = '/api/upload', set Upload = "data", provide file via binary property, optionally set Query parameters

Links

Discussion