API resource

Facebook Page and Messenger

The connected Page's public details (about, description, contact details, hours) and its Messenger setup: the persistent menu, the Get Started button, the greeting shown before someone writes and the ice breaker questions.

Get a Facebook Page's public info

GET/v1/accounts/{accountId}/facebook-page-info

Works on: Facebook

Returns the public info of the Page selected on a facebook account: about, description, website, phone, emails and opening hours, as Meta returns them from the Page node. Text fields the Page never filled come back as null.

Path parameters

accountIdstringrequired

The ID of a connected Facebook account.

curl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/facebook-page-info" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "about": "string",
  "description": "string",
  "website": "string",
  "phone": "string",
  "emails": [
    "string"
  ],
  "hours": {}
}

Update a Facebook Page's public info

PATCH/v1/accounts/{accountId}/facebook-page-info

Works on: Facebook

Updates the public info of the Page selected on a facebook account. Only the fields in the body are sent to Meta, every other field keeps its value. Send an empty string to clear a text field. Unknown fields are rejected with a 400. Returns the Page info read back from Meta after the update. Meta needs the pages_manage_metadata permission and a Page role that can edit the Page: without them Meta's refusal comes back as platform_api_error.

Path parameters

accountIdstringrequired

The ID of a connected Facebook account.

Body

aboutstring

Short description, shown as Description in the Page's Edit Page Info.

descriptionstring

Longer text, shown as Additional Information.

websitestring

URL of the Page's website.

phonestring

emailsstring[]

Replaces every email listed on the Page.

hoursobject

Replaces the opening hours. Keys are {day}_{slot}_{open|close} with day mon to sun and slot 1 or 2, values are 24h HH:MM times.

curl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/facebook-page-info" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "about": "string"
  }'
Response 200
{
  "about": "string",
  "description": "string",
  "website": "string",
  "phone": "string",
  "emails": [
    "string"
  ],
  "hours": {}
}

Get persistent menu

GET/v1/accounts/{accountId}/messenger-menu

Works on: Facebook

Get the persistent menu configuration for a Facebook Messenger or Instagram account. Instagram accounts connected through Facebook Login are read through their linked Page (Meta's platform=instagram), Instagram Login accounts through the Instagram API.

Path parameters

accountIdstringrequired

curl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-menu" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "data": [
    {}
  ]
}

Set persistent menu

PUT/v1/accounts/{accountId}/messenger-menu

Works on: Facebook

Set the persistent menu for a Facebook Messenger or Instagram account. Max 3 top-level items, max 5 nested items. - On Facebook, Meta only shows a persistent menu on a page that has a Get Started button. Set one first with PUT /v1/accounts/{accountId}/messenger-get-started. - A postback button whose payload is creatoros:workflow:<workflowId> starts that workflow when tapped. The workflow must be active on this account and profile.

Path parameters

accountIdstringrequired

Body

persistent_menuobject[]required

Persistent menu configuration array (Meta format)

curl -X PUT "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-menu" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "persistent_menu": [
      {}
    ]
  }'
Response 200
{
  "ok": true
}

Delete persistent menu

DELETE/v1/accounts/{accountId}/messenger-menu

Works on: Facebook

Removes the persistent menu from this Facebook Messenger or Instagram account.

Path parameters

accountIdstringrequired

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-menu" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "ok": true
}

Get FB Get Started button

GET/v1/accounts/{accountId}/messenger-get-started

Works on: Facebook

Get the Get Started button payload for a Facebook Messenger account. data is null when the page has none.

Path parameters

accountIdstringrequired

curl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-get-started" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "data": {
    "payload": "string"
  }
}

Set FB Get Started button

PUT/v1/accounts/{accountId}/messenger-get-started

Works on: Facebook

Set the Get Started button shown on a Facebook page's Messenger welcome screen. Meta requires it before a persistent menu can be set. Tapping it sends a postback with payload, which arrives as a message.received webhook carrying it in metadata.postbackPayload. Use creatoros:workflow:<workflowId> to start a workflow on the tap; the workflow must be active on this account and profile.

Path parameters

accountIdstringrequired

Body

payloadstringrequired

Postback payload sent when a person taps Get Started, e.g. GET_STARTED or creatoros:workflow:<workflowId>.

curl -X PUT "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-get-started" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": "string"
  }'
Response 200
{
  "success": true
}

Delete FB Get Started button

DELETE/v1/accounts/{accountId}/messenger-get-started

Works on: Facebook

Remove the Get Started button. Meta refuses while a persistent menu is set, so delete the menu first.

Path parameters

accountIdstringrequired

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-get-started" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "success": true
}

Get FB greeting text

GET/v1/accounts/{accountId}/messenger-greeting

Works on: Facebook

Get the greeting text a Facebook page shows on its Messenger welcome screen, one entry per locale. data is empty when the page has none.

Path parameters

accountIdstringrequired

curl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-greeting" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "data": [
    {
      "locale": "string",
      "text": "string"
    }
  ]
}

Set FB greeting text

PUT/v1/accounts/{accountId}/messenger-greeting

Works on: Facebook

Set the greeting text on a Facebook page's Messenger welcome screen (Meta's greeting Messenger Profile field). One entry must use locale default; add more for other locales. Meta personalises {{user_first_name}}, {{user_last_name}} and {{user_full_name}}. Replaces every locale already set.

Path parameters

accountIdstringrequired

Body

greetingobject[]required

One entry per locale; one must use locale default.

curl -X PUT "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-greeting" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "greeting": [
      {
        "locale": "string",
        "text": "string"
      }
    ]
  }'
Response 200
{
  "success": true
}

Delete FB greeting text

DELETE/v1/accounts/{accountId}/messenger-greeting

Works on: Facebook

Remove the greeting text from every locale.

Path parameters

accountIdstringrequired

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-greeting" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "success": true
}

Get FB ice breakers

GET/v1/accounts/{accountId}/messenger-ice-breakers

Works on: Facebook

Get the ice breakers (FAQ questions shown when a person opens a new Messenger thread) for a Facebook page, one entry per locale. Instagram ice breakers live at /v1/accounts/{accountId}/instagram-ice-breakers.

Path parameters

accountIdstringrequired

curl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-ice-breakers" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "data": [
    {
      "locale": "string",
      "call_to_actions": [
        {}
      ]
    }
  ]
}

Set FB ice breakers

PUT/v1/accounts/{accountId}/messenger-ice-breakers

Works on: Facebook

Set up to 4 ice breakers per locale for a Facebook page (Meta's ice_breakers Messenger Profile field). Replaces every locale already set. - One entry must use locale default. - A tap sends a postback with the question's payload, which arrives as message.received with metadata.postbackPayload. - Use creatoros:workflow:<workflowId> to start a workflow (it must be active on this account and profile).

Path parameters

accountIdstringrequired

Body

ice_breakersobject[]required

One entry per locale; one must use locale default.

curl -X PUT "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-ice-breakers" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ice_breakers": [
      {
        "locale": "string",
        "call_to_actions": [
          {
            "question": "string",
            "payload": "string"
          }
        ]
      }
    ]
  }'
Response 200
{
  "success": true
}

Delete FB ice breakers

DELETE/v1/accounts/{accountId}/messenger-ice-breakers

Works on: Facebook

Remove the ice breakers from every locale.

Path parameters

accountIdstringrequired

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-ice-breakers" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"
Response 200
{
  "success": true
}