{
"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
Replace Settings
Creates or updates rollout, handoff, follow-up, audience, and response-policy settings for the agent. YCloud omits null fields before calling Meta. Omitting never_say_phrases preserves the current list, an empty list clears it, and a non-empty list fully replaces it.
PUT
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.
Body
application/json
Meta Business Agent ID when explicit selection is required.
Replacement rollout configuration.
Show child attributes
Show child attributes
Replacement handoff configuration supported by the current YCloud contract.
Show child attributes
Show child attributes
Replacement follow-up configuration.
Show child attributes
Show child attributes
ALLOWLISTED_ONLY for testing or EVERYONE for full rollout.
Available options:
ALLOWLISTED_ONLY, EVERYONE Complete list of phrases the agent must not say. Omit to preserve the current list, send an empty array to clear it, or send a non-empty array to replace it.
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