[
{
"agent_id": "<string>",
"channel": "<string>",
"rollout": {
"enabled": true
},
"handoff": {
"enabled": true,
"message_selection": "DEFAULT",
"message": "<string>"
},
"followup": {
"enabled": true,
"followup_interval_in_seconds": 0,
"message": "<string>"
},
"ai_audience": "ALLOWLISTED_ONLY"
}
]{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}Agent Settings
Get Settings
Returns the current agent settings as a list. Pass agent_id to target a specific settings object; when it is omitted, Meta returns the latest settings for the channel.
GET
https://api.ycloud.com/v2
/
metaBusinessAgents
/
{entityId}
/
settings
[
{
"agent_id": "<string>",
"channel": "<string>",
"rollout": {
"enabled": true
},
"handoff": {
"enabled": true,
"message_selection": "DEFAULT",
"message": "<string>"
},
"followup": {
"enabled": true,
"followup_interval_in_seconds": 0,
"message": "<string>"
},
"ai_audience": "ALLOWLISTED_ONLY"
}
]{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}Authorizations
Path Parameters
WhatsApp Business Phone Number ID that owns the Meta Business Agent.
Query Parameters
Response
Operation completed successfully.
Meta Business Agent ID.
Channel associated with the agent.
Live rollout configuration.
Show child attributes
Show child attributes
Human handoff configuration supported by the current YCloud contract.
Show child attributes
Show child attributes
Inactivity follow-up configuration.
Show child attributes
Show child attributes
Audience allowed to receive agent responses.
Available options:
ALLOWLISTED_ONLY, EVERYONE