Skip to main content
Facebook IntegrationVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Body

locationIdstringrequired

Location identifier

Example:loc_abc123
namestringrequired

Conversation form name

Example:Welcome Form
textstringrequired

Welcome message text

Example:Hi! How can we help?
questionsobject[]required

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

Response

The stored conversation form

_idstringrequired

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

Example:6a8666ec867e604d24f5a49b
namestringrequired

Form name

Example:Untitled form 20 Aug 26, 08:00 AM
textstringrequired

Opening message

Example:Hi there! Please let us know how we can help you.
locationIdstringrequired

Owning location

Example:fRMewNQIxSyZ5R4nQyit
questionsobject[]required

Prompt and canned-reply pairs as stored

createdAtstringrequired

Creation time, ISO-8601

Example:2026-08-20T02:31:08.055Z
updatedAtstringrequired

Last modification time, ISO-8601

Example:2026-08-20T02:31:08.055Z
__vnumber

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

Example:0