Create conversation form

POST 
/ad-publishing/facebook/conversation-forms

Create a Messenger conversation form. Note the created record is returned in its raw stored form rather than the shape the listing endpoint uses: the identifier comes back as _id instead of id, and the internal __v version key is included.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location identifier

namestringrequired

Conversation form name

textstringrequired

Welcome message text

questionsobject[]required

Quick-reply questions shown in the welcome message of the conversation form

Example (auto)

{
  "locationId": "loc_abc123",
  "name": "Welcome Form",
  "text": "Hi! How can we help?",
  "questions": [
    {
      "question": "How can we help?",
      "response": "Thanks for reaching out! A team member will assist you shortly."
    },
    {
      "question": "I want to learn more",
      "response": "Great! Here is a link to our services."
    }
  ]
}

application/json

The stored conversation form

application/json

Schema

Schema

_idstringrequired

Conversation form id. Note _id, not the id the listing endpoint returns for the same record.

namestringrequired

Form name

textstringrequired

Opening message

locationIdstringrequired

Owning location

questionsobject[]required

Prompt and canned-reply pairs as stored

createdAtstringrequired

Creation time, ISO-8601

updatedAtstringrequired

Last modification time, ISO-8601

__vnumber

Mongo document version key, leaked by this branch only. Not part of the contract.

Example (auto)

{
  "_id": "6a8666ec867e604d24f5a49b",
  "name": "Untitled form 20 Aug 26, 08:00 AM",
  "text": "Hi there! Please let us know how we can help you.",
  "locationId": "fRMewNQIxSyZ5R4nQyit",
  "questions": [
    {
      "question": "Your question",
      "response": "Click the link below to view the product page.",
      "_id": "6a831fb01aa9a84ff992aefd"
    }
  ],
  "createdAt": "2026-08-20T02:31:08.055Z",
  "updatedAt": "2026-08-20T02:31:08.055Z",
  "__v": 0
}