Accounts & connections · Account Settings
Fetches an FB Get Started button.
GET
https://api.pozy.ai/v1/accounts/{accountId}/messenger-get-startedgetMessengerGetStarted
Guides: Facebook, Conversation starters
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Example
curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/messenger-get-started" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/messenger-get-started", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/messenger-get-started",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
dataobjectCan be null.
payloadstring
200 response
{
"data": {
"payload": "string"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Account Settings
GETGet a Facebook Page's public infoPATCHUpdate a Facebook Page's public infoGETGet persistent menuPUTSet persistent menuDELDelete persistent menuPUTSet FB Get Started buttonDELDelete FB Get Started buttonGETGet FB greeting textPUTSet FB greeting textDELDelete FB greeting textGETGet FB ice breakersPUTSet FB ice breakersDELDelete FB ice breakersGETGet IG ice breakersPUTSet IG ice breakersDELDelete IG ice breakersGETGet TG bot commandsPUTSet TG bot commandsDELDelete TG bot commands