[TEST] [Bug]: How to create data with collection have dynamic inside

[pwizla]

Link to the documentation page or resource

https://docs.strapi.io/dev-docs/api/rest

Describe the bug

Hi, I am developing CMS to manage content. I have a collection containing dynamic zones. When I create data with REST API, I get the issue:

• if I add __component then I get error 400 - Invalid key __component
• if I don't add __component then I get error 400 - messages[0].__component is a required field
  I want to know. How to create data have dynamic zone with REST API?
  strapi version: 5.5.0
  node: 18.19.0

Additional context

curl --location 'http://localhost:1337/api/prompts' \ --header 'Content-Type: application/json' \ --data '{ "data": { "messages": [ { "contents": [ { "text": "[Completed Task: -1]\nHi there! What can I get for you today?\n[Next Task: 1]" } ], "role": "assistant" } ], } }'

curl --location 'http://localhost:1337/api/prompts' \ --header 'Content-Type: application/json' \ --data '{ "data": { "messages": [ { "contents": [ { "text": "[Completed Task: -1]\nHi there! What can I get for you today?\n[Next Task: 1]" } ], "__component": "prompt.message-text", "role": "assistant" } ], } }'

curl --location 'http://localhost:1337/api/prompts' \ --header 'Content-Type: application/json' \ --data '{ "data": { "messages": [ { "contents": [ { "text": "[Completed Task: -1]\nHi there! What can I get for you today?\n[Next Task: 1]" } ], "__component": "", "role": "assistant" } ], } }'

Suggested improvements or fixes
No response

Related issue(s)/PR(s)
No response

Suggested improvements or fixes

No response

Related issue(s)/PR(s)

No response

[github-actions]

🤖 I've analyzed your question and here's what I found:

Hi there! Thank you so much for reaching out and providing detailed information about your issue, including your cURL examples and screenshots. We really appreciate your effort and your engagement with the Strapi community!

Understanding Dynamic Zones in Strapi v5 REST API

In Strapi v5, when creating or updating entries that include dynamic zones via the REST API, each object inside the dynamic zone must include the __component key. This key tells Strapi which component type to use for that entry. The value should be the full component name in the format category.component-name (e.g., "prompt.message-text").

Common Pitfalls

• 400 - Invalid key __component: This error can occur if the __component key is not in the correct place, is misspelled, or the value is not a valid component name.
• 400 - __component is a required field: This means Strapi expects the __component key for each item in the dynamic zone array.

Example: Creating an Entry with a Dynamic Zone

Suppose your collection type is prompts and it has a dynamic zone field called messages, which can include a component named prompt.message-text. Your request body should look like this:

{
  "data": {
    "messages": [
      {
        "__component": "prompt.message-text",
        "contents": [
          { "text": "[Completed Task: -1]\nHi there! What can I get for you today?\n[Next Task: 1]" }
        ],
        "role": "assistant"
      }
    ]
  }
}

Your cURL command would be:

curl --location 'http://localhost:1337/api/prompts' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": {
      "messages": [
        {
          "__component": "prompt.message-text",
          "contents": [
            { "text": "[Completed Task: -1]\nHi there! What can I get for you today?\n[Next Task: 1]" }
          ],
          "role": "assistant"
        }
      ]
    }
  }'

Make sure:

• The __component key is present and correctly set for every object in the dynamic zone array.
• The value matches the exact component name as defined in your Strapi project.

Documentation & Further Reading

• Dynamic zones in model schemas
• REST API: Population & Field Selection
• How to structure dynamic zone data in REST API requests

If You Still Encounter Issues

If you continue to see errors after following this structure, it could be a bug or a misconfiguration. In that case, please double-check:

• The component name and spelling.
• That the component is enabled for the dynamic zone in your content-type builder.
• Your Strapi version (you mentioned 5.5.0, which is correct for these instructions).

If you believe this is a bug in Strapi, please let us know and we can flag it for the core team (@pwizla). Otherwise, for more real-time help, you can also join our Discord community or post on the Strapi Forum.

Thank you again for your detailed report and for being part of the Strapi community! If you have any more questions or need further assistance, feel free to ask. 😊

📚 Relevant documentation:

• Strapi v4 to Strapi 5 breaking changes
• Community & Support
• 🧠 Understanding the populate parameter for the REST API
• GraphQL API
• Content-type Builder
• Content Manager
• Content-type Builder
• 🧠 Understanding the populate parameter for the REST API
• 🧠 Understanding the populate parameter for the REST API
• Models
• REST API: Population & Field Selection
• 🧠 Understanding the populate parameter for the REST API
• Components and dynamic zones should be populated using the detailed population strategy (on fragments)
• Document Service API: Populating fields
• Creating components and dynamic zones with the Entity Service API

---

ℹ️ This response was generated automatically. If this doesn't fully answer your question or if you need further assistance, please mention @pwizla in a comment and a human maintainer will help you.

You can also try our interactive AI chat for more detailed assistance.

💡 For feature requests or product feedback, visit feedback.strapi.io.