Webflow API and Documentation · Example Payload

Webflow Api And Documentation Webflow Create Item Live Example

CMSContent ManagementEcommerceNo-CodePublishingWeb Development

Webflow Api And Documentation Webflow Create Item Live Example is an example object payload from Webflow API and Documentation, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "create-item-live",
  "method": "POST",
  "path": "/collections/{collection_id}/items/live",
  "summary": "Webflow Create Live Collection Item(s)",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "SingleItem",
      "example": {
        "isArchived": false,
        "isDraft": false,
        "fieldData": {
          "name": "The Hitchhiker's Guide to the Galaxy",
          "slug": "hitchhikers-guide-to-the-galaxy",
          "plain-text": "Don't Panic.",
          "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
          "main-image": {
            "fileId": "62b720ef280c7a7a3be8cabe",
            "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
          },
          "image-gallery": [
            {
              "fileId": "62b720ef280c7a7a3be8cabd",
              "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
            },
            {
              "fileId": "62b720ef280c7a7a3be8cabe",
              "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
            }
          ],
          "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
          "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
          "contact-email": "zaphod.beeblebrox@heartofgold.gov",
          "support-phone": "424-242-4242",
          "answer-to-everything": 42,
          "release-date": "1979-10-12T00:00:00.000Z",
          "is-featured": true,
          "brand-color": "#000000",
          "category": "62b720ef280c7a7a3be8cabf",
          "author": "62b720ef280c7a7a3be8cab0",
          "tags": [
            "62b720ef280c7a7a3be8cab1",
            "62b720ef280c7a7a3be8cab2"
          ],
          "downloadable-asset": {
            "fileId": "62b720ef280c7a7a3be8cab3",
            "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
          }
        }
      }
    },
    {
      "contentType": "application/json",
      "name": "MultipleItems",
      "example": {
        "items": [
          {
            "isArchived": false,
            "isDraft": false,
            "fieldData": {
              "name": "Senior Data Analyst",
              "slug": "senior-data-analyst",
              "url": "https://boards.greenhouse.io/webflow/jobs/26567701",
              "department": "Data"
            }
          },
          {
            "isArchived": false,
            "isDraft": false,
            "fieldData": {
              "name": "Product Manager",
              "slug": "product-manager",
              "url": "https://boards.greenhouse.io/webflow/jobs/31234567",
              "department": "Product"
            }
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "code": "bad_request",
        "message": "Bad Request: Request is malformed",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "code": "not_authorized",
        "message": "Request not authorized",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "resource_not_found",
        "message": "Requested resource not found: The site cannot be found",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "429",
      "contentType": "application/json",
      "example": {
        "code": "too_many_requests",
        "message": "Too many requests",
        "externalReference": null,
        "details": []
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "code": "internal_error",
        "message": "An Internal Error occurred",
        "externalReference": null,
        "details": []
      }
    }
  ]
}