{
"agent_id": "<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>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}Agent Onboarding
Onboard Agent
Starts onboarding for the phone number, creates the required agent resources, and schedules asynchronous data preparation. The optional request body may provide catalog_id; onboarding alone does not enable customer replies.
POST
https://api.ycloud.com/v2
/
metaBusinessAgents
/
{entityId}
/
onboarding
{
"agent_id": "<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>"
}
}{
"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
Optional Meta catalog ID associated with the agent.
Response
Operation completed successfully.
Meta Business Agent ID created for the phone number.