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
/v1/accounts/{accountId}/facebook-page-infoWorks on: Facebook
Path parameters
accountIdstringrequiredThe 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"{
"about": "string",
"description": "string",
"website": "string",
"phone": "string",
"emails": [
"string"
],
"hours": {}
}Update a Facebook Page's public info
/v1/accounts/{accountId}/facebook-page-infoWorks on: Facebook
Path parameters
accountIdstringrequiredThe ID of a connected Facebook account.
Body
aboutstringShort description, shown as Description in the Page's Edit Page Info.
descriptionstringLonger text, shown as Additional Information.
websitestringURL of the Page's website.
phonestringemailsstring[]Replaces every email listed on the Page.
hoursobjectReplaces 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"
}'{
"about": "string",
"description": "string",
"website": "string",
"phone": "string",
"emails": [
"string"
],
"hours": {}
}Get FB Get Started button
/v1/accounts/{accountId}/messenger-get-startedWorks on: Facebook
Path parameters
accountIdstringrequiredcurl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-get-started" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"data": {
"payload": "string"
}
}Set FB Get Started button
/v1/accounts/{accountId}/messenger-get-startedWorks on: Facebook
Path parameters
accountIdstringrequiredBody
payloadstringrequiredPostback 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"
}'{
"success": true
}Delete FB Get Started button
/v1/accounts/{accountId}/messenger-get-startedWorks on: Facebook
Path parameters
accountIdstringrequiredcurl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-get-started" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"success": true
}Get FB greeting text
/v1/accounts/{accountId}/messenger-greetingWorks on: Facebook
Path parameters
accountIdstringrequiredcurl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-greeting" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"data": [
{
"locale": "string",
"text": "string"
}
]
}Set FB greeting text
/v1/accounts/{accountId}/messenger-greetingWorks on: Facebook
Path parameters
accountIdstringrequiredBody
greetingobject[]requiredOne 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"
}
]
}'{
"success": true
}Delete FB greeting text
/v1/accounts/{accountId}/messenger-greetingWorks on: Facebook
Path parameters
accountIdstringrequiredcurl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-greeting" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"success": true
}Get FB ice breakers
/v1/accounts/{accountId}/messenger-ice-breakersWorks on: Facebook
Path parameters
accountIdstringrequiredcurl "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-ice-breakers" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"data": [
{
"locale": "string",
"call_to_actions": [
{}
]
}
]
}Set FB ice breakers
/v1/accounts/{accountId}/messenger-ice-breakersWorks on: Facebook
Path parameters
accountIdstringrequiredBody
ice_breakersobject[]requiredOne 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"
}
]
}
]
}'{
"success": true
}Delete FB ice breakers
/v1/accounts/{accountId}/messenger-ice-breakersWorks on: Facebook
Path parameters
accountIdstringrequiredcurl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/accounts/acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r/messenger-ice-breakers" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"success": true
}